home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / text / misc / texinfo216.lzh / texinfo.tex (.txt) < prev    next >
LaTeX Document  |  1992-10-05  |  119KB  |  2,912 lines

  1. %% TeX macros to handle texinfo files
  2. %   Copyright (C) 1985, 86, 88, 90, 91, 92 Free Software Foundation, Inc.
  3. %This texinfo.tex file is free software; you can redistribute it and/or
  4. %modify it under the terms of the GNU General Public License as
  5. %published by the Free Software Foundation; either version 2, or (at
  6. %your option) any later version.
  7. %This texinfo.tex file is distributed in the hope that it will be
  8. %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  9. %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10. %General Public License for more details.
  11. %You should have received a copy of the GNU General Public License
  12. %along with this texinfo.tex file; see the file COPYING.  If not, write
  13. %to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
  14. %USA.
  15. %In other words, you are welcome to use, share and improve this program.
  16. %You are forbidden to forbid anyone else to use, share and improve
  17. %what you give them.   Help stamp out software-hoarding!
  18. \def\texinfoversion{2.86}
  19. \message{Loading texinfo package [Version \texinfoversion]:}
  20. \message{}
  21. % Print the version number if in a .fmt file.
  22. \everyjob{\message{[Texinfo version \texinfoversion]}\message{}}
  23. % Save some parts of plain tex whose names we will redefine.
  24. \let\ptexlbrace=\{
  25. \let\ptexrbrace=\}
  26. \let\ptexdots=\dots
  27. \let\ptexdot=\.
  28. \let\ptexstar=\*
  29. \let\ptexend=\end
  30. \let\ptexbullet=\bullet
  31. \let\ptexb=\b
  32. \let\ptexc=\c
  33. \let\ptexi=\i
  34. \let\ptext=\t
  35. \let\ptexl=\l
  36. \let\ptexL=\L
  37. \def\tie{\penalty 10000\ }     % Save plain tex definition of ~.
  38. \message{Basics,}
  39. \chardef\other=12
  40. % If this character appears in an error message or help string, it
  41. % starts a new line in the output.
  42. \newlinechar = `^^J
  43. % Ignore a token.
  44. \def\gobble#1{}
  45. \hyphenation{ap-pen-dix}
  46. \hyphenation{mini-buf-fer mini-buf-fers}
  47. \hyphenation{eshell}
  48. % Margin to add to right of even pages, to left of odd pages.
  49. \newdimen \bindingoffset  \bindingoffset=0pt
  50. \newdimen \normaloffset   \normaloffset=\hoffset
  51. \newdimen\pagewidth \newdimen\pageheight
  52. \pagewidth=\hsize \pageheight=\vsize
  53. % Sometimes it is convenient to have everything in the transcript file
  54. % and nothing on the terminal.  We don't just call \tracingall here,
  55. % since that produces some useless output on the terminal.
  56. \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
  57. \def\loggingall{\tracingcommands2 \tracingstats2 
  58.    \tracingpages1 \tracingoutput1 \tracinglostchars1 
  59.    \tracingmacros2 \tracingparagraphs1 \tracingrestores1 
  60.    \showboxbreadth\maxdimen\showboxdepth\maxdimen
  61. %---------------------Begin change-----------------------
  62. %%%% For @cropmarks command.
  63. % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
  64. \newdimen\cornerlong \newdimen\cornerthick
  65. \newdimen \topandbottommargin
  66. \newdimen \outerhsize \newdimen \outervsize
  67. \cornerlong=1pc\cornerthick=.3pt    % These set size of cropmarks
  68. \outerhsize=7in
  69. %\outervsize=9.5in
  70. % Alternative @smallbook page size is 9.25in
  71. \outervsize=9.25in
  72. \topandbottommargin=.75in
  73. %---------------------End change-----------------------
  74. % \onepageout takes a vbox as an argument.  Note that \pagecontents
  75. % does insertions itself, but you have to call it yourself.
  76. \chardef\PAGE=255  \output={\onepageout{\pagecontents\PAGE}}
  77. \def\onepageout#1{\hoffset=\normaloffset
  78. \ifodd\pageno  \advance\hoffset by \bindingoffset
  79. \else \advance\hoffset by -\bindingoffset\fi
  80. {\escapechar=`\\\relax % makes sure backslash is used in output files.
  81. \shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
  82. {\let\hsize=\pagewidth \makefootline}}}%
  83. \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
  84. %%%% For @cropmarks command %%%%
  85. % Here is a modification of the main output routine for Near East Publications
  86. % This provides right-angle cropmarks at all four corners.
  87. % The contents of the page are centerlined into the cropmarks,
  88. % and any desired binding offset is added as an \hskip on either
  89. % site of the centerlined box.  (P. A. MacKay, 12 November, 1986)
  90. \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
  91.          \shipout
  92.          \vbox to \outervsize{\hsize=\outerhsize
  93.                  \vbox{\line{\ewtop\hfill\ewtop}}
  94.                  \nointerlineskip
  95.                  \line{\vbox{\moveleft\cornerthick\nstop}
  96.                        \hfill
  97.                        \vbox{\moveright\cornerthick\nstop}}
  98.                  \vskip \topandbottommargin
  99.                  \centerline{\ifodd\pageno\hskip\bindingoffset\fi
  100.             \vbox{
  101.             {\let\hsize=\pagewidth \makeheadline}
  102.             \pagebody{#1}
  103.             {\let\hsize=\pagewidth \makefootline}}
  104.             \ifodd\pageno\else\hskip\bindingoffset\fi}
  105.          \vskip \topandbottommargin plus1fill minus1fill
  106.                  \boxmaxdepth\cornerthick
  107.                  \line{\vbox{\moveleft\cornerthick\nsbot}
  108.                        \hfill
  109.                        \vbox{\moveright\cornerthick\nsbot}}
  110.                  \nointerlineskip
  111.                  \vbox{\line{\ewbot\hfill\ewbot}}
  112.   \advancepageno 
  113.   \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
  114. % Do @cropmarks to get crop marks
  115. \def\cropmarks{\let\onepageout=\croppageout }
  116. \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
  117. {\catcode`\@ =11
  118. \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
  119. \dimen@=\dp#1 \unvbox#1
  120. \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
  121. \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
  122. % Here are the rules for the cropmarks.  Note that they are
  123. % offset so that the space between them is truly \outerhsize or \outervsize
  124. % (P. A. MacKay, 12 November, 1986)
  125. \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
  126. \def\nstop{\vbox
  127.   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
  128. \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
  129. \def\nsbot{\vbox
  130.   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
  131. % Parse an argument, then pass it to #1.  The argument is the rest of
  132. % the input line (except we remove a trailing comment).  #1 should be a
  133. % macro which expects an ordinary undelimited TeX argument.
  134. \def\parsearg#1{%
  135.   \let\next = #1%
  136.   \begingroup
  137.     \obeylines
  138.     \futurelet\temp\parseargx
  139. % If the next token is an obeyed space (from an @example environment or
  140. % the like), remove it and recurse.  Otherwise, we're done.
  141. \def\parseargx{%
  142.   \ifx\obeyedspace\temp
  143.     \expandafter\parseargdiscardspace
  144.   \else
  145.     \expandafter\parseargline
  146.   \fi
  147. % Remove a single space (as the delimiter token to the macro call).
  148. {\obeyspaces %
  149.  \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
  150. \gdef\obeyedspace{\ }
  151. {\obeylines %
  152.   \gdef\parseargline#1^^M{%
  153.     \endgroup % End of the group started in \parsearg.
  154.     %
  155.     % First remove any @c comment, then any @comment.
  156.     % Result of each macro is put in \toks0.
  157.     \argremovec #1\c\relax %
  158.     \expandafter\argremovecomment \the\toks0 \comment\relax %
  159.     %
  160.     % Call the caller's macro, saved as \next in \parsearg.
  161.     \expandafter\next\expandafter{\the\toks0}%
  162. % Since all \c{,omment} does is throw away the argument, we can let TeX
  163. % do that for us.  The \relax here is matched by the \relax in the call
  164. % in \parseargline; it could be more or less anything, its purpose is
  165. % just to delimit the argument to the \c.
  166. \def\argremovec#1\c#2\relax{\toks0 = {#1}}
  167. \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
  168. % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
  169. %    @end itemize  @c foo
  170. % will have two active spaces as part of the argument with the
  171. % `itemize'.  Here we remove all active spaces from #1, and assign the
  172. % result to \toks0.
  173. % This loses if there are any *other* active characters besides spaces
  174. % in the argument -- _ ^ +, for example -- since they get expanded.
  175. % Fortunately, Texinfo does not define any such commands.  (If it ever
  176. % does, the catcode of the characters in questionwill have to be changed
  177. % here.)  But this means we cannot call \removeactivespaces as part of
  178. % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
  179. % that \parsearg gets might well have any character at all in it.
  180. \def\removeactivespaces#1{%
  181.   \begingroup
  182.     \ignoreactivespaces
  183.     \edef\temp{#1}%
  184.     \global\toks0 = \expandafter{\temp}%
  185.   \endgroup
  186. % Change the active space to expand to nothing.
  187. \begingroup
  188.   \obeyspaces
  189.   \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
  190. \endgroup
  191. \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
  192. %% These are used to keep @begin/@end levels from running away
  193. %% Call \inENV within environments (after a \begingroup)
  194. \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
  195. \def\ENVcheck{%
  196. \ifENV\errmessage{Still within an environment.  Type Return to continue.}
  197. \endgroup\fi} % This is not perfect, but it should reduce lossage
  198. % @begin foo  is the same as @foo, for now.
  199. \newhelp\EMsimple{Type <Return> to continue.}
  200. \outer\def\begin{\parsearg\beginxxx}
  201. \def\beginxxx #1{%
  202. \expandafter\ifx\csname #1\endcsname\relax
  203. {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
  204. \csname #1\endcsname\fi}
  205. % @end foo executes the definition of \Efoo.
  206. \def\end{\parsearg\endxxx}
  207. \def\endxxx #1{%
  208.   \removeactivespaces{#1}%
  209.   \edef\endthing{\the\toks0}%
  210.   \expandafter\ifx\csname E\endthing\endcsname\relax
  211.     \expandafter\ifx\csname \endthing\endcsname\relax
  212.       % There's no \foo, i.e., no ``environment'' foo.
  213.       \errhelp = \EMsimple
  214.       \errmessage{Undefined command `@end \endthing'}%
  215.     \else
  216.       % There is an environment foo, but it hasn't been started.
  217.       \errhelp = \EMsimple
  218.       \errmessage{This `@end \endthing' doesn't have a matching `@\endthing'}%
  219.     \fi
  220.   \else
  221.     % Everything's ok; the right environment has been started.
  222.     \csname E\endthing\endcsname
  223.   \fi
  224. % Single-spacing is done by various environments.
  225. \newskip\singlespaceskip \singlespaceskip = \baselineskip
  226. \def\singlespace{%
  227. {\advance \baselineskip by -\singlespaceskip
  228. \kern \baselineskip}%
  229. \baselineskip=\singlespaceskip
  230. %% Simple single-character @ commands
  231. % @@ prints an @
  232. % Kludge this until the fonts are right (grr).
  233. \def\@{{\tt \char '100}}
  234. % This is turned off because it was never documented
  235. % and you can use @w{...} around a quote to suppress ligatures.
  236. %% Define @` and @' to be the same as ` and '
  237. %% but suppressing ligatures.
  238. %\def\`{{`}}
  239. %\def\'{{'}}
  240. % Used to generate quoted braces.
  241. \def\mylbrace {{\tt \char '173}}
  242. \def\myrbrace {{\tt \char '175}}
  243. \let\{=\mylbrace
  244. \let\}=\myrbrace
  245. % @: forces normal size whitespace following.
  246. \def\:{\spacefactor=1000 }
  247. % @* forces a line break.
  248. \def\*{\hfil\break\hbox{}\ignorespaces}
  249. % @. is an end-of-sentence period.
  250. \def\.{.\spacefactor=3000 }
  251. % @w prevents a word break.  Without the \leavevmode, @w at the
  252. % beginning of a paragraph, when TeX is still in vertical mode, would
  253. % produce a whole line of output instead of starting the paragraph.
  254. \def\w#1{\leavevmode\hbox{#1}}
  255. % @group ... @end group forces ... to be all on one page, by enclosing
  256. % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
  257. % to keep its height that of a normal line.  According to the rules for
  258. % \topskip (p.114 of the TeXbook), the glue inserted is
  259. % max (\topskip - \ht (first item), 0).  If that height is large,
  260. % therefore, no glue is inserted, and the space between the headline and
  261. % the text is small, which looks bad.
  262. \def\group{\begingroup
  263.   \ifnum\catcode13=\active \else
  264.     \errhelp = \groupinvalidhelp
  265.     \errmessage{@group invalid in context where filling is enabled}%
  266.   \fi
  267.   % The \vtop we start below produces a box with large depth; thus, TeX
  268.   % puts \baselineskip glue before it, and (when the next line of text
  269.   % is done) \lineskip glue after it.  (See p.82 of the TeXbook.)  But
  270.   % the next line of text also gets us \parskip glue.  Final result:
  271.   % space below is slightly more than space above.
  272.   \def\Egroup{%
  273.     \egroup           % End the \vtop.
  274.     \endgroup         % End the \group.
  275.   \vtop\bgroup
  276.     % We do @comment here in case we are called inside an environment,
  277.     % such as @example, where each end-of-line in the input causes an
  278.     % end-of-line in the output.  We don't want the end-of-line after
  279.     % the `@group' to put extra space in the output.  Since @group
  280.     % should appear on a line by itself (according to the Texinfo
  281.     % manual), we don't worry about eating any user text.
  282.     \comment
  283. % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
  284. % message, so this ends up printing `@group can only ...'.
  285. \newhelp\groupinvalidhelp{%
  286. group can only be used in environments such as @example,^^J%
  287. where each line of input produces a line of output.}
  288. % @need space-in-mils
  289. % forces a page break if there is not space-in-mils remaining.
  290. \newdimen\mil  \mil=0.001in
  291. \def\need{\parsearg\needx}
  292. % Old definition--didn't work.
  293. %\def\needx #1{\par %
  294. %% This method tries to make TeX break the page naturally
  295. %% if the depth of the box does not fit.
  296. %{\baselineskip=0pt%
  297. %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
  298. %\prevdepth=-1000pt
  299. \def\needx#1{%
  300.   % Go into vertical mode, so we don't make a big box in the middle of a
  301.   % paragraph.
  302.   \par
  303.   % Don't add any leading before our big empty box, but allow a page
  304.   % break, since the best break might be right here.
  305.   \allowbreak
  306.   \nointerlineskip
  307.   \vtop to #1\mil{\vfil}%
  308.   % TeX does not even consider page breaks if a penalty added to the
  309.   % main vertical list is 10000 or more.  But in order to see if the
  310.   % empty box we just added fits on the page, we must make it consider
  311.   % page breaks.  On the other hand, we don't want to actually break the
  312.   % page after the empty box.  So we use a penalty of 9999.
  313.   % There is an extremely small chance that TeX will actually break the
  314.   % page at this \penalty, if there are no other feasible breakpoints in
  315.   % sight.  (If the user is using lots of big @group commands, which
  316.   % almost-but-not-quite fill up a page, TeX will have a hard time doing
  317.   % good page breaking, for example.)  However, I could not construct an
  318.   % example where a page broke at this \penalty; if it happens in a real
  319.   % document, then we can reconsider our strategy.
  320.   \penalty9999
  321.   % Back up by the size of the box, whether we did a page break or not.
  322.   \kern -#1\mil
  323.   % Do not allow a page break right after this kern.
  324.   \nobreak
  325. % @br   forces paragraph break
  326. \let\br = \par
  327. % @dots{}  output some dots
  328. \def\dots{$\ldots$}
  329. % @page    forces the start of a new page
  330. \def\page{\par\vfill\supereject}
  331. % @exdent text....
  332. % outputs text on separate line in roman font, starting at standard page margin
  333. % This records the amount of indent in the innermost environment.
  334. % That's how much \exdent should take out.
  335. \newskip\exdentamount
  336. % This defn is used inside fill environments such as @defun.
  337. \def\exdent{\parsearg\exdentyyy}
  338. \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
  339. % This defn is used inside nofill environments such as @example.
  340. \def\nofillexdent{\parsearg\nofillexdentyyy}
  341. \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
  342. \leftline{\hskip\leftskip{\rm#1}}}}
  343. %\hbox{{\rm#1}}\hfil\break}}
  344. % @include file    insert text of that file as input.
  345. \def\include{\parsearg\includezzz}
  346. \def\includezzz #1{{\def\thisfile{#1}\input #1
  347. \def\thisfile{}
  348. % @center line   outputs that line, centered
  349. \def\center{\parsearg\centerzzz}
  350. \def\centerzzz #1{{\advance\hsize by -\leftskip
  351. \advance\hsize by -\rightskip
  352. \centerline{#1}}}
  353. % @sp n   outputs n lines of vertical space
  354. \def\sp{\parsearg\spxxx}
  355. \def\spxxx #1{\par \vskip #1\baselineskip}
  356. % @comment ...line which is ignored...
  357. % @c is the same as @comment
  358. % @ignore ... @end ignore  is another way to write a comment
  359. \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
  360. \parsearg \commentxxx}
  361. \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
  362. \let\c=\comment
  363. % Prevent errors for section commands.
  364. % Used in @ignore and in failing conditionals.
  365. \def\ignoresections{%
  366. \let\chapter=\relax
  367. \let\unnumbered=\relax
  368. \let\top=\relax
  369. \let\unnumberedsec=\relax
  370. \let\unnumberedsection=\relax
  371. \let\unnumberedsubsec=\relax
  372. \let\unnumberedsubsection=\relax
  373. \let\unnumberedsubsubsec=\relax
  374. \let\unnumberedsubsubsection=\relax
  375. \let\section=\relax
  376. \let\subsec=\relax
  377. \let\subsubsec=\relax
  378. \let\subsection=\relax
  379. \let\subsubsection=\relax
  380. \let\appendix=\relax
  381. \let\appendixsec=\relax
  382. \let\appendixsection=\relax
  383. \let\appendixsubsec=\relax
  384. \let\appendixsubsection=\relax
  385. \let\appendixsubsubsec=\relax
  386. \let\appendixsubsubsection=\relax
  387. \let\contents=\relax
  388. \let\smallbook=\relax
  389. \let\titlepage=\relax
  390. % Ignore @ignore ... @end ignore.
  391. \def\ignore{\doignore{ignore}}
  392. % We ignore @ifinfo text.
  393. \def\ifinfo{\doignore{ifinfo}}
  394. % Ignore text until a line `@end #1'.
  395. \def\doignore#1{\begingroup
  396.   % Don't complain about control sequences we have declared \outer.
  397.   \ignoresections
  398.   % Define a command to swallow text until we reach `@end #1'.
  399.   \long\def\doignoretext##1\end #1{\enddoignore}%
  400.   % Make sure that spaces turn into tokens that match what \doignoretext wants.
  401.   \catcode32 = 10
  402.   % And now expand that command.
  403.   \doignoretext
  404. % What we do to finish off ignored text.
  405. \def\enddoignore{\endgroup\ignorespaces}%
  406. \def\direntry{\begingroup\direntryxxx}
  407. \long\def\direntryxxx #1\end direntry{\endgroup\ignorespaces}
  408. % Conditionals to test whether a flag is set.
  409. \def\ifset{\begingroup\ignoresections\parsearg\ifsetxxx}
  410. \def\ifsetxxx #1{\endgroup
  411. \expandafter\ifx\csname SET#1\endcsname\relax \let\temp=\ifsetfail
  412. \else \let\temp=\relax \fi
  413. \temp}
  414. \def\Eifset{}
  415. \def\ifsetfail{\doignore{ifset}}
  416. \def\ifclear{\begingroup\ignoresections\parsearg\ifclearxxx}
  417. \def\ifclearxxx #1{\endgroup
  418. \expandafter\ifx\csname SET#1\endcsname\relax \let\temp=\relax
  419. \else \let\temp=\ifclearfail \fi
  420. \temp}
  421. \def\Eifclear{}
  422. \def\ifclearfail{\doignore{ifclear}}
  423. % @set foo
  424. %       to set the flag named foo to a default value (empty)
  425. % @set foo REST-OF-LINE
  426. %    to set the flag named foo to a text string REST-OF-LINE
  427. % @clear foo   to clear the flag named foo.
  428. % @value{foo} to set the text saved in foo
  429. % @set command, work macro \setyyy
  430. \def\setyyy#1 #2\endsetyyy{\expandafter\xdef\csname SET#1\endcsname{#2\unskip}}
  431. \def\setxxx#1{\setyyy#1 \endsetyyy}
  432. \def\set{\parsearg\setxxx}
  433. \def\clear{\parsearg\clearxxx}
  434. \def\clearxxx #1{
  435. \expandafter\let\csname SET#1\endcsname=\relax}
  436. \def\value#1{\expandafter
  437.         \ifx\csname SET#1\endcsname\relax
  438.             {\{No value for ``#1''\}}
  439.         \else \csname SET#1\endcsname \fi}
  440. % Some texinfo constructs that are trivial in tex
  441. \def\iftex{}
  442. \def\Eiftex{}
  443. \long\def\menu #1\end menu{}
  444. \def\asis#1{#1}
  445. % @math means output in math mode.
  446. % We don't use $'s directly in the definition of \math because control
  447. % sequences like \math are expanded when the toc file is written.  Then,
  448. % we read the toc file back, the $'s will be normal characters (as they
  449. % should be, according to the definition of Texinfo).  So we must use a
  450. % control sequence to switch into and out of math mode.
  451. % This isn't quite enough for @math to work properly in indices, but it
  452. % seems unlikely it will ever be needed there.
  453. \let\implicitmath = $
  454. \def\math#1{\implicitmath #1\implicitmath}
  455. \def\node{\ENVcheck\parsearg\nodezzz}
  456. \def\nodezzz#1{\nodexxx [#1,]}
  457. \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
  458. \let\lastnode=\relax
  459. \def\donoderef{\ifx\lastnode\relax\else
  460. \expandafter\expandafter\expandafter\setref{\lastnode}\fi
  461. \let\lastnode=\relax}
  462. \def\unnumbnoderef{\ifx\lastnode\relax\else
  463. \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
  464. \let\lastnode=\relax}
  465. \def\appendixnoderef{\ifx\lastnode\relax\else
  466. \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
  467. \let\lastnode=\relax}
  468. \let\refill=\relax
  469. % @setfilename is done at the beginning of every texinfo file.
  470. % So open here the files we need to have open while reading the input.
  471. % This makes it possible to make a .fmt file for texinfo.
  472. \def\setfilename{%
  473.    \readauxfile
  474.    \opencontents
  475.    \openindices
  476.    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
  477.    \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
  478.    \comment % Ignore the actual filename.
  479. \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
  480. \def\inforef #1{\inforefzzz #1,,,,**}
  481. \def\inforefzzz #1,#2,#3,#4**{See Info file \file{\losespace#3{}},
  482.   node \samp{\losespace#1{}}}
  483. \def\losespace #1{#1}
  484. \message{fonts,}
  485. % Font-change commands.
  486. % Texinfo supports the sans serif font style, which plain TeX does not.
  487. % So we set up a \sf analogous to plain's \rm, etc.
  488. \newfam\sffam
  489. \def\sf{\fam=\sffam \tensf}
  490. \let\li = \sf % Sometimes we call it \li, not \sf.
  491. %% Try out Computer Modern fonts at \magstephalf
  492. \let\mainmagstep=\magstephalf
  493. \ifx\bigger\relax
  494. \let\mainmagstep=\magstep1
  495. \font\textrm=cmr12
  496. \font\texttt=cmtt12
  497. \else
  498. \font\textrm=cmr10 scaled \mainmagstep
  499. \font\texttt=cmtt10 scaled \mainmagstep
  500. % Instead of cmb10, you many want to use cmbx10.
  501. % cmbx10 is a prettier font on its own, but cmb10
  502. % looks better when embedded in a line with cmr10.
  503. \font\textbf=cmb10 scaled \mainmagstep 
  504. \font\textit=cmti10 scaled \mainmagstep
  505. \font\textsl=cmsl10 scaled \mainmagstep
  506. \font\textsf=cmss10 scaled \mainmagstep
  507. \font\textsc=cmcsc10 scaled \mainmagstep
  508. \font\texti=cmmi10 scaled \mainmagstep
  509. \font\textsy=cmsy10 scaled \mainmagstep
  510. % A few fonts for @defun, etc.
  511. \font\defbf=cmbx10 scaled \magstep1 %was 1314
  512. \font\deftt=cmtt10 scaled \magstep1
  513. \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
  514. % Fonts for indices and small examples.
  515. % We actually use the slanted font rather than the italic, 
  516. % because texinfo normally uses the slanted fonts for that.
  517. % Do not make many font distinctions in general in the index, since they
  518. % aren't very useful.
  519. \font\ninett=cmtt9
  520. \font\indrm=cmr9
  521. \font\indit=cmsl9
  522. \let\indsl=\indit
  523. \let\indtt=\ninett
  524. \let\indsf=\indrm
  525. \let\indbf=\indrm
  526. \let\indsc=\indrm
  527. \font\indi=cmmi9
  528. \font\indsy=cmsy9
  529. % Fonts for headings
  530. \font\chaprm=cmbx12 scaled \magstep2
  531. \font\chapit=cmti12 scaled \magstep2
  532. \font\chapsl=cmsl12 scaled \magstep2
  533. \font\chaptt=cmtt12 scaled \magstep2
  534. \font\chapsf=cmss12 scaled \magstep2
  535. \let\chapbf=\chaprm
  536. \font\chapsc=cmcsc10 scaled\magstep3
  537. \font\chapi=cmmi12 scaled \magstep2
  538. \font\chapsy=cmsy10 scaled \magstep3
  539. \font\secrm=cmbx12 scaled \magstep1
  540. \font\secit=cmti12 scaled \magstep1
  541. \font\secsl=cmsl12 scaled \magstep1
  542. \font\sectt=cmtt12 scaled \magstep1
  543. \font\secsf=cmss12 scaled \magstep1
  544. \font\secbf=cmbx12 scaled \magstep1
  545. \font\secsc=cmcsc10 scaled\magstep2
  546. \font\seci=cmmi12 scaled \magstep1
  547. \font\secsy=cmsy10 scaled \magstep2
  548. % \font\ssecrm=cmbx10 scaled \magstep1    % This size an font looked bad.
  549. % \font\ssecit=cmti10 scaled \magstep1    % The letters were too crowded.
  550. % \font\ssecsl=cmsl10 scaled \magstep1
  551. % \font\ssectt=cmtt10 scaled \magstep1
  552. % \font\ssecsf=cmss10 scaled \magstep1
  553. %\font\ssecrm=cmb10 scaled 1315    % Note the use of cmb rather than cmbx.
  554. %\font\ssecit=cmti10 scaled 1315    % Also, the size is a little larger than
  555. %\font\ssecsl=cmsl10 scaled 1315    % being scaled magstep1.
  556. %\font\ssectt=cmtt10 scaled 1315
  557. %\font\ssecsf=cmss10 scaled 1315
  558. %\let\ssecbf=\ssecrm
  559. \font\ssecrm=cmbx12 scaled \magstephalf
  560. \font\ssecit=cmti12 scaled \magstephalf
  561. \font\ssecsl=cmsl12 scaled \magstephalf
  562. \font\ssectt=cmtt12 scaled \magstephalf
  563. \font\ssecsf=cmss12 scaled \magstephalf
  564. \font\ssecbf=cmbx12 scaled \magstephalf
  565. \font\ssecsc=cmcsc10 scaled \magstep1 
  566. \font\sseci=cmmi12 scaled \magstephalf
  567. \font\ssecsy=cmsy10 scaled \magstep1
  568. % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
  569. % but that is not a standard magnification.
  570. % Fonts for title page:
  571. \font\titlerm = cmbx12 scaled \magstep3
  572. \let\authorrm = \secrm
  573. % In order for the font changes to affect most math symbols and letters,
  574. % we have to define the \textfont of the standard families.  Since
  575. % texinfo doesn't allow for producing subscripts and superscripts, we
  576. % don't bother to reset \scriptfont and \scriptscriptfont (which would
  577. % also require loading a lot more fonts).
  578. \def\resetmathfonts{%
  579.   \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
  580.   \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
  581.   \textfont\ttfam = \tentt \textfont\sffam = \tensf
  582. % The font-changing commands redefine the meanings of \tenSTYLE, instead
  583. % of just \STYLE.  We do this so that font changes will continue to work
  584. % in math mode, where it is the current \fam that is relevant in most
  585. % cases, not the current.  Plain TeX does, for example,
  586. % \def\bf{\fam=\bffam \tenbf}  By redefining \tenbf, we obviate the need
  587. % to redefine \bf itself.  
  588. \def\textfonts{%
  589.   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
  590.   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
  591.   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
  592.   \resetmathfonts}
  593. \def\chapfonts{%
  594.   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl 
  595.   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
  596.   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
  597.   \resetmathfonts}
  598. \def\secfonts{%
  599.   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
  600.   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
  601.   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
  602.   \resetmathfonts}
  603. \def\subsecfonts{%
  604.   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
  605.   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
  606.   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
  607.   \resetmathfonts}
  608. \def\indexfonts{%
  609.   \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
  610.   \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
  611.   \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy
  612.   \resetmathfonts}
  613. % Set up the default fonts, so we can use them for creating boxes.
  614. \textfonts
  615. % Count depth in font-changes, for error checks
  616. \newcount\fontdepth \fontdepth=0
  617. % Fonts for short table of contents.
  618. \font\shortcontrm=cmr12
  619. \font\shortcontbf=cmbx12
  620. \font\shortcontsl=cmsl12
  621. %% Add scribe-like font environments, plus @l for inline lisp (usually sans
  622. %% serif) and @ii for TeX italic
  623. % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
  624. % unless the following character is such as not to need one.
  625. \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
  626. \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
  627. \let\i=\smartitalic
  628. \let\var=\smartitalic
  629. \let\dfn=\smartitalic
  630. \let\emph=\smartitalic
  631. \let\cite=\smartitalic
  632. \def\b#1{{\bf #1}}
  633. \let\strong=\b
  634. \def\t#1{{\tt \exhyphenpenalty=10000\rawbackslash \frenchspacing #1}\null}
  635. \let\ttfont = \t
  636. %\def\samp #1{`{\tt \rawbackslash \frenchspacing #1}'\null}
  637. \def\samp #1{`\tclose{#1}'\null}
  638. \def\key #1{{\tt \exhyphenpenalty=10000\uppercase{#1}}\null}
  639. \def\ctrl #1{{\tt \rawbackslash \hat}#1}
  640. \let\file=\samp
  641. % @code is a modification of @t,
  642. % which makes spaces the same size as normal in the surrounding text.
  643. \newdimen\tclosesave
  644. \newdimen\tcloserm
  645. \def\tclose#1{{\rm \tcloserm=\fontdimen2\font \tt \tclosesave=\fontdimen2\font
  646. \fontdimen2\font=\tcloserm
  647. % prevent breaking lines at hyphens.
  648. \exhyphenpenalty=10000
  649. \def\ {{\fontdimen2\font=\tclosesave{} }}%
  650.  \rawbackslash \frenchspacing #1\fontdimen2\font=\tclosesave}\null}
  651. \let\code=\tclose
  652. %\let\exp=\tclose  %Was temporary
  653. % @kbd is like @code, except that if the argument is just one @key command, 
  654. % then @kbd has no effect.
  655. \def\xkey{\key}
  656. \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
  657. \ifx\one\xkey\ifx\threex\three \key{#2}%
  658. \else\tclose{\look}\fi
  659. \else\tclose{\look}\fi}
  660. % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
  661. % argument is to make the input look right: @dmn{pt} instead of
  662. % @dmn{}pt.
  663. \def\dmn#1{\thinspace #1}
  664. \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
  665. \def\l#1{{\li #1}\null}        % 
  666. \def\r#1{{\rm #1}}        % roman font
  667. % Use of \lowercase was suggested.
  668. \def\sc#1{{\smallcaps#1}}    % smallcaps font
  669. \def\ii#1{{\it #1}}        % italic font
  670. \message{page headings,}
  671. \newskip\titlepagetopglue \titlepagetopglue = 1.5in
  672. \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
  673. % First the title page.  Must do @settitle before @titlepage.
  674. \def\titlefont#1{{\titlerm #1}}
  675. \newtoks\realeverypar
  676. \newif\ifseenauthor
  677. \newif\iffinishedtitlepage
  678. \def\titlepage{\begingroup \parindent=0pt \textfonts
  679.    \let\subtitlerm=\tenrm
  680. % I deinstalled the following change because \cmr12 is undefined.
  681. % This change was not in the ChangeLog anyway.  --rms.
  682. %   \let\subtitlerm=\cmr12
  683.    \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
  684.    \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
  685.    % Leave some space at the very top of the page.
  686.    \vglue\titlepagetopglue
  687.    % Now you can print the title using @title.
  688.    \def\title{\parsearg\titlezzz}%
  689.    \def\titlezzz##1{\leftline{\titlefont{##1}}
  690.             % print a rule at the page bottom also.
  691.             \finishedtitlepagefalse
  692.             \vskip4pt \hrule height 4pt \vskip4pt}%
  693.    % No rule at page bottom unless we print one at the top with @title.
  694.    \finishedtitlepagetrue
  695.    % Now you can put text using @subtitle.
  696.    \def\subtitle{\parsearg\subtitlezzz}%
  697.    \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
  698.    % @author should come last, but may come many times.
  699.    \def\author{\parsearg\authorzzz}%
  700.    \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
  701.       {\authorfont \leftline{##1}}}%
  702.    %  
  703.    % Most title ``pages'' are actually two pages long, with space
  704.    % at the top of the second.  We don't want the ragged left on the second.
  705.    \let\oldpage = \page
  706.    \def\page{%
  707.       \iffinishedtitlepage\else
  708.      \finishtitlepage
  709.       \fi
  710.       \oldpage
  711.       \let\page = \oldpage
  712.       \hbox{}}%
  713. %   \def\page{\oldpage \hbox{}}
  714. \def\Etitlepage{%
  715.    \iffinishedtitlepage\else
  716.       \finishtitlepage
  717.    \fi
  718.    % It is important to do the page break before ending the group,
  719.    % because the headline and footline are only empty inside the group.
  720.    % If we use the new definition of \page, we always get a blank page
  721.    % after the title page, which we certainly don't want.
  722.    \oldpage
  723.    \endgroup
  724.    \HEADINGSon
  725. \def\finishtitlepage{%
  726.    \vskip4pt \hrule height 2pt
  727.    \vskip\titlepagebottomglue
  728.    \finishedtitlepagetrue
  729. %%% Set up page headings and footings.
  730. \let\thispage=\folio
  731. \newtoks \evenheadline    % Token sequence for heading line of even pages
  732. \newtoks \oddheadline     % Token sequence for heading line of odd pages
  733. \newtoks \evenfootline    % Token sequence for footing line of even pages
  734. \newtoks \oddfootline     % Token sequence for footing line of odd pages
  735. % Now make Tex use those variables
  736. \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
  737.                             \else \the\evenheadline \fi}}
  738. \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
  739.                             \else \the\evenfootline \fi}\HEADINGShook}
  740. \let\HEADINGShook=\relax
  741. % Commands to set those variables.
  742. % For example, this is what  @headings on  does
  743. % @evenheading @thistitle|@thispage|@thischapter
  744. % @oddheading @thischapter|@thispage|@thistitle
  745. % @evenfooting @thisfile||
  746. % @oddfooting ||@thisfile
  747. \def\evenheading{\parsearg\evenheadingxxx}
  748. \def\oddheading{\parsearg\oddheadingxxx}
  749. \def\everyheading{\parsearg\everyheadingxxx}
  750. \def\evenfooting{\parsearg\evenfootingxxx}
  751. \def\oddfooting{\parsearg\oddfootingxxx}
  752. \def\everyfooting{\parsearg\everyfootingxxx}
  753. {\catcode`\@=0 %
  754. \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
  755. \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
  756. \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  757. \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
  758. \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
  759. \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  760. \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
  761. \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
  762. \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
  763. \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  764. \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
  765. \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
  766. \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  767. \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
  768. \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
  769. \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  770. \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
  771. \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
  772. \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
  773. \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
  774. }% unbind the catcode of @.
  775. % @headings double    turns headings on for double-sided printing.
  776. % @headings single    turns headings on for single-sided printing.
  777. % @headings off        turns them off.
  778. % @headings on        same as @headings double, retained for compatibility.
  779. % @headings after    turns on double-sided headings after this page.
  780. % @headings doubleafter    turns on double-sided headings after this page.
  781. % @headings singleafter turns on single-sided headings after this page.
  782. % By default, they are off.
  783. \def\headings #1 {\csname HEADINGS#1\endcsname}
  784. \def\HEADINGSoff{
  785. \global\evenheadline={\hfil} \global\evenfootline={\hfil}
  786. \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
  787. \HEADINGSoff
  788. % When we turn headings on, set the page number to 1.
  789. % For double-sided printing, put current file name in lower left corner,
  790. % chapter name on inside top of right hand pages, document
  791. % title on inside top of left hand pages, and page numbers on outside top
  792. % edge of all pages.
  793. \def\HEADINGSdouble{
  794. %\pagealignmacro
  795. \global\pageno=1
  796. \global\evenfootline={\hfil}
  797. \global\oddfootline={\hfil}
  798. \global\evenheadline={\line{\folio\hfil\thistitle}}
  799. \global\oddheadline={\line{\thischapter\hfil\folio}}
  800. % For single-sided printing, chapter title goes across top left of page,
  801. % page number on top right.
  802. \def\HEADINGSsingle{
  803. %\pagealignmacro
  804. \global\pageno=1
  805. \global\evenfootline={\hfil}
  806. \global\oddfootline={\hfil}
  807. \global\evenheadline={\line{\thischapter\hfil\folio}}
  808. \global\oddheadline={\line{\thischapter\hfil\folio}}
  809. \def\HEADINGSon{\HEADINGSdouble}
  810. \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
  811. \let\HEADINGSdoubleafter=\HEADINGSafter
  812. \def\HEADINGSdoublex{%
  813. \global\evenfootline={\hfil}
  814. \global\oddfootline={\hfil}
  815. \global\evenheadline={\line{\folio\hfil\thistitle}}
  816. \global\oddheadline={\line{\thischapter\hfil\folio}}
  817. \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
  818. \def\HEADINGSsinglex{%
  819. \global\evenfootline={\hfil}
  820. \global\oddfootline={\hfil}
  821. \global\evenheadline={\line{\thischapter\hfil\folio}}
  822. \global\oddheadline={\line{\thischapter\hfil\folio}}
  823. % Subroutines used in generating headings
  824. % Produces Day Month Year style of output.
  825. \def\today{\number\day\space
  826. \ifcase\month\or
  827. January\or February\or March\or April\or May\or June\or
  828. July\or August\or September\or October\or November\or December\fi
  829. \space\number\year}
  830. % Use this if you want the Month Day, Year style of output.
  831. %\def\today{\ifcase\month\or
  832. %January\or February\or March\or April\or May\or June\or
  833. %July\or August\or September\or October\or November\or December\fi
  834. %\space\number\day, \number\year}
  835. % @settitle line...  specifies the title of the document, for headings
  836. % It generates no output of its own
  837. \def\thistitle{No Title}
  838. \def\settitle{\parsearg\settitlezzz}
  839. \def\settitlezzz #1{\gdef\thistitle{#1}}
  840. \message{tables,}
  841. % @tabs -- simple alignment
  842. % These don't work.  For one thing, \+ is defined as outer.
  843. % So these macros cannot even be defined.
  844. %\def\tabs{\parsearg\tabszzz}
  845. %\def\tabszzz #1{\settabs\+#1\cr}
  846. %\def\tabline{\parsearg\tablinezzz}
  847. %\def\tablinezzz #1{\+#1\cr}
  848. %\def\&{&}
  849. % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
  850. % default indentation of table text
  851. \newdimen\tableindent \tableindent=.8in
  852. % default indentation of @itemize and @enumerate text
  853. \newdimen\itemindent  \itemindent=.3in
  854. % margin between end of table item and start of table text.
  855. \newdimen\itemmargin  \itemmargin=.1in
  856. % used internally for \itemindent minus \itemmargin
  857. \newdimen\itemmax
  858. % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
  859. % these defs.
  860. % They also define \itemindex
  861. % to index the item name in whatever manner is desired (perhaps none).
  862. \def\internalBitem{\smallbreak \parsearg\itemzzz}
  863. \def\internalBitemx{\par \parsearg\itemzzz}
  864. \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
  865. \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \par \parsearg\xitemzzz}
  866. \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
  867. \def\internalBkitemx{\par \parsearg\kitemzzz}
  868. \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
  869.                  \itemzzz {#1}}
  870. \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
  871.                  \itemzzz {#1}}
  872. \def\itemzzz #1{\begingroup %
  873.   \advance\hsize by -\rightskip
  874.   \advance\hsize by -\tableindent
  875.   \setbox0=\hbox{\itemfont{#1}}%
  876.   \itemindex{#1}%
  877.   \nobreak % This prevents a break before @itemx.
  878.   % Be sure we are not still in the middle of a paragraph.
  879.   \parskip=0in
  880.   \par
  881.   % If the item text does not fit in the space we have, put it on a line
  882.   % by itself, and do not allow a page break either before or after that
  883.   % line.  We do not start a paragraph here because then if the next
  884.   % command is, e.g., @kindex, the whatsit would get put into the
  885.   % horizontal list on a line by itself, resulting in extra blank space.
  886.   \ifdim \wd0>\itemmax
  887.     \setbox0=\hbox{\hskip \leftskip \hskip -\tableindent \unhbox0}\box0
  888.     \nobreak
  889.   \else
  890.     % The item text fits into the space.  Start a paragraph, so that the
  891.     % following text (if any) will end up on the same line.  Since that
  892.     % text will be indented by \tableindent, we make the item text be in
  893.     % a zero-width box.
  894.     \noindent
  895.     \rlap{\hskip -\tableindent\box0}%
  896.   \fi
  897.   \endgroup
  898. \def\item{\errmessage{@item while not in a table}}
  899. \def\itemx{\errmessage{@itemx while not in a table}}
  900. \def\kitem{\errmessage{@kitem while not in a table}}
  901. \def\kitemx{\errmessage{@kitemx while not in a table}}
  902. \def\xitem{\errmessage{@xitem while not in a table}}
  903. \def\xitemx{\errmessage{@xitemx while not in a table}}
  904. %% Contains a kludge to get @end[description] to work
  905. \def\description{\tablez{\dontindex}{1}{}{}{}{}}
  906. \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
  907. {\obeylines\obeyspaces%
  908. \gdef\tablex #1^^M{%
  909. \tabley\dontindex#1        \endtabley}}
  910. \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
  911. {\obeylines\obeyspaces%
  912. \gdef\ftablex #1^^M{%
  913. \tabley\fnitemindex#1        \endtabley
  914. \def\Eftable{\endgraf\endgroup\afterenvbreak}%
  915. \let\Etable=\relax}}
  916. \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
  917. {\obeylines\obeyspaces%
  918. \gdef\vtablex #1^^M{%
  919. \tabley\vritemindex#1        \endtabley
  920. \def\Evtable{\endgraf\endgroup\afterenvbreak}%
  921. \let\Etable=\relax}}
  922. \def\dontindex #1{}
  923. \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
  924. \def\vritemindex #1{\doind {vr}{\code{#1}}}%
  925. {\obeyspaces %
  926. \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
  927. \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
  928. \def\tablez #1#2#3#4#5#6{%
  929. \aboveenvbreak %
  930. \begingroup %
  931. \def\Edescription{\Etable}% Neccessary kludge.
  932. \let\itemindex=#1%
  933. \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
  934. \ifnum 0#4>0 \tableindent=#4\mil \fi %
  935. \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
  936. \def\itemfont{#2}%
  937. \itemmax=\tableindent %
  938. \advance \itemmax by -\itemmargin %
  939. \advance \leftskip by \tableindent %
  940. \exdentamount=\tableindent
  941. \parindent = 0pt
  942. \parskip = \smallskipamount
  943. \ifdim \parskip=0pt \parskip=2pt \fi%
  944. \def\Etable{\endgraf\endgroup\afterenvbreak}%
  945. \let\item = \internalBitem %
  946. \let\itemx = \internalBitemx %
  947. \let\kitem = \internalBkitem %
  948. \let\kitemx = \internalBkitemx %
  949. \let\xitem = \internalBxitem %
  950. \let\xitemx = \internalBxitemx %
  951. % This is the counter used by @enumerate, which is really @itemize
  952. \newcount \itemno
  953. \def\itemize{\parsearg\itemizezzz}
  954. \def\itemizezzz #1{%
  955.   \begingroup % ended by the @end itemsize
  956.   \itemizey {#1}{\Eitemize}
  957. \def\itemizey #1#2{%
  958. \aboveenvbreak %
  959. \itemmax=\itemindent %
  960. \advance \itemmax by -\itemmargin %
  961. \advance \leftskip by \itemindent %
  962. \exdentamount=\itemindent
  963. \parindent = 0pt %
  964. \parskip = \smallskipamount %
  965. \ifdim \parskip=0pt \parskip=2pt \fi%
  966. \def#2{\endgraf\endgroup\afterenvbreak}%
  967. \def\itemcontents{#1}%
  968. \let\item=\itemizeitem}
  969. \def\bullet{$\ptexbullet$}
  970. \def\minus{$-$}
  971. % Set sfcode to normal for the chars that usually have another value.
  972. % These are `.?!:;,'
  973. \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
  974.   \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
  975. % \splitoff TOKENS\endmark defines \first to be the first token in
  976. % TOKENS, and \rest to be the remainder.
  977. \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
  978. % Allow an optional argument of an uppercase letter, lowercase letter,
  979. % or number, to specify the first label in the enumerated list.  No
  980. % argument is the same as `1'.
  981. \def\enumerate{\parsearg\enumeratezzz}
  982. \def\enumeratezzz #1{\enumeratey #1  \endenumeratey}
  983. \def\enumeratey #1 #2\endenumeratey{%
  984.   \begingroup % ended by the @end enumerate
  985.   % If we were given no argument, pretend we were given `1'.
  986.   \def\thearg{#1}%
  987.   \ifx\thearg\empty \def\thearg{1}\fi
  988.   % Detect if the argument is a single token.  If so, it might be a
  989.   % letter.  Otherwise, the only valid thing it can be is a number.
  990.   % (We will always have one token, because of the test we just made.
  991.   % This is a good thing, since \splitoff doesn't work given nothing at
  992.   % all -- the first parameter is undelimited.)
  993.   \expandafter\splitoff\thearg\endmark
  994.   \ifx\rest\empty
  995.     % Only one token in the argument.  It could still be anything.
  996.     % A ``lowercase letter'' is one whose \lccode is nonzero.
  997.     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
  998.     %   not equal to itself.
  999.     % Otherwise, we assume it's a number.
  1000.     % 
  1001.     % We need the \relax at the end of the \ifnum lines to stop TeX from
  1002.     % continuing to look for a <number>.
  1003.     % 
  1004.     \ifnum\lccode\expandafter`\thearg=0\relax 
  1005.       \numericenumerate % a number (we hope)
  1006.     \else
  1007.       % It's a letter.
  1008.       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
  1009.         \lowercaseenumerate % lowercase letter
  1010.       \else
  1011.         \uppercaseenumerate % uppercase letter
  1012.       \fi
  1013.     \fi
  1014.   \else
  1015.     % Multiple tokens in the argument.  We hope it's a number.
  1016.     \numericenumerate
  1017.   \fi
  1018. % An @enumerate whose labels are integers.  The starting integer is
  1019. % given in \thearg.
  1020. \def\numericenumerate{%
  1021.   \itemno = \thearg
  1022.   \startenumeration{\the\itemno}%
  1023. % The starting (lowercase) letter is in \thearg.
  1024. \def\lowercaseenumerate{%
  1025.   \itemno = \expandafter`\thearg
  1026.   \startenumeration{%
  1027.     % Be sure we're not beyond the end of the alphabet.
  1028.     \ifnum\itemno=0
  1029.       \errmessage{No more lowercase letters in @enumerate; get a bigger
  1030.                   alphabet}%
  1031.     \fi
  1032.     \char\lccode\itemno
  1033. % The starting (uppercase) letter is in \thearg.
  1034. \def\uppercaseenumerate{%
  1035.   \itemno = \expandafter`\thearg
  1036.   \startenumeration{%
  1037.     % Be sure we're not beyond the end of the alphabet.
  1038.     \ifnum\itemno=0
  1039.       \errmessage{No more uppercase letters in @enumerate; get a bigger
  1040.                   alphabet}
  1041.     \fi
  1042.     \char\uccode\itemno
  1043. % Call itemizey, adding a period to the first argument and supplying the
  1044. % common last two arguments.  Also subtract one from the initial value in
  1045. % \itemno, since @item increments \itemno.
  1046. \def\startenumeration#1{%
  1047.   \advance\itemno by -1
  1048.   \itemizey{#1.}\Eenumerate\flushcr
  1049. % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
  1050. % to @enumerate.
  1051. \def\alphaenumerate{\enumerate{a}}
  1052. \def\capsenumerate{\enumerate{A}}
  1053. \def\Ealphaenumerate{\Eenumerate}
  1054. \def\Ecapsenumerate{\Eenumerate}
  1055. % Definition of @item while inside @itemize.
  1056. \def\itemizeitem{%
  1057. \advance\itemno by 1
  1058. {\let\par=\endgraf \smallbreak}%
  1059. \ifhmode \errmessage{\in hmode at itemizeitem}\fi
  1060. {\parskip=0in \hskip 0pt
  1061. \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
  1062. \vadjust{\penalty 1200}}%
  1063. \flushcr}
  1064. \message{indexing,}
  1065. % Index generation facilities
  1066. % Define \newwrite to be identical to plain tex's \newwrite
  1067. % except not \outer, so it can be used within \newindex.
  1068. {\catcode`\@=11
  1069. \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
  1070. % \newindex {foo} defines an index named foo.
  1071. % It automatically defines \fooindex such that
  1072. % \fooindex ...rest of line... puts an entry in the index foo.
  1073. % It also defines \fooindfile to be the number of the output channel for
  1074. % the file that    accumulates this index.  The file's extension is foo.
  1075. % The name of an index should be no more than 2 characters long
  1076. % for the sake of vms.
  1077. \def\newindex #1{
  1078. \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
  1079. \openout \csname#1indfile\endcsname \jobname.#1    % Open the file
  1080. \expandafter\xdef\csname#1index\endcsname{%    % Define \xxxindex
  1081. \noexpand\doindex {#1}}
  1082. % @defindex foo  ==  \newindex{foo}
  1083. \def\defindex{\parsearg\newindex}
  1084. % Define @defcodeindex, like @defindex except put all entries in @code.
  1085. \def\newcodeindex #1{
  1086. \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
  1087. \openout \csname#1indfile\endcsname \jobname.#1    % Open the file
  1088. \expandafter\xdef\csname#1index\endcsname{%    % Define \xxxindex
  1089. \noexpand\docodeindex {#1}}
  1090. \def\defcodeindex{\parsearg\newcodeindex}
  1091. % @synindex foo bar    makes index foo feed into index bar.
  1092. % Do this instead of @defindex foo if you don't want it as a separate index.
  1093. \def\synindex #1 #2 {%
  1094. \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
  1095. \expandafter\let\csname#1indfile\endcsname=\synindexfoo
  1096. \expandafter\xdef\csname#1index\endcsname{%    % Define \xxxindex
  1097. \noexpand\doindex {#2}}%
  1098. % @syncodeindex foo bar   similar, but put all entries made for index foo
  1099. % inside @code.
  1100. \def\syncodeindex #1 #2 {%
  1101. \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
  1102. \expandafter\let\csname#1indfile\endcsname=\synindexfoo
  1103. \expandafter\xdef\csname#1index\endcsname{%    % Define \xxxindex
  1104. \noexpand\docodeindex {#2}}%
  1105. % Define \doindex, the driver for all \fooindex macros.
  1106. % Argument #1 is generated by the calling \fooindex macro,
  1107. %  and it is "foo", the name of the index.
  1108. % \doindex just uses \parsearg; it calls \doind for the actual work.
  1109. % This is because \doind is more useful to call from other macros.
  1110. % There is also \dosubind {index}{topic}{subtopic}
  1111. % which makes an entry in a two-level index such as the operation index.
  1112. \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
  1113. \def\singleindexer #1{\doind{\indexname}{#1}}
  1114. % like the previous two, but they put @code around the argument.
  1115. \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
  1116. \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
  1117. \def\indexdummies{%
  1118. \def\_{{\realbackslash _}}%
  1119. \def\w{\realbackslash w }%
  1120. \def\bf{\realbackslash bf }%
  1121. \def\rm{\realbackslash rm }%
  1122. \def\sl{\realbackslash sl }%
  1123. \def\sf{\realbackslash sf}%
  1124. \def\tt{\realbackslash tt}%
  1125. \def\gtr{\realbackslash gtr}%
  1126. \def\less{\realbackslash less}%
  1127. \def\hat{\realbackslash hat}%
  1128. \def\char{\realbackslash char}%
  1129. \def\TeX{\realbackslash TeX}%
  1130. \def\dots{\realbackslash dots }%
  1131. \def\copyright{\realbackslash copyright }%
  1132. \def\tclose##1{\realbackslash tclose {##1}}%
  1133. \def\code##1{\realbackslash code {##1}}%
  1134. \def\samp##1{\realbackslash samp {##1}}%
  1135. \def\t##1{\realbackslash r {##1}}%
  1136. \def\r##1{\realbackslash r {##1}}%
  1137. \def\i##1{\realbackslash i {##1}}%
  1138. \def\b##1{\realbackslash b {##1}}%
  1139. \def\cite##1{\realbackslash cite {##1}}%
  1140. \def\key##1{\realbackslash key {##1}}%
  1141. \def\file##1{\realbackslash file {##1}}%
  1142. \def\var##1{\realbackslash var {##1}}%
  1143. \def\kbd##1{\realbackslash kbd {##1}}%
  1144. % \indexnofonts no-ops all font-change commands.
  1145. % This is used when outputting the strings to sort the index by.
  1146. \def\indexdummyfont#1{#1}
  1147. \def\indexdummytex{TeX}
  1148. \def\indexdummydots{...}
  1149. \def\indexnofonts{%
  1150. \let\w=\indexdummyfont
  1151. \let\t=\indexdummyfont
  1152. \let\r=\indexdummyfont
  1153. \let\i=\indexdummyfont
  1154. \let\b=\indexdummyfont
  1155. \let\emph=\indexdummyfont
  1156. \let\strong=\indexdummyfont
  1157. \let\cite=\indexdummyfont
  1158. \let\sc=\indexdummyfont
  1159. %Don't no-op \tt, since it isn't a user-level command
  1160. % and is used in the definitions of the active chars like <, >, |...
  1161. %\let\tt=\indexdummyfont
  1162. \let\tclose=\indexdummyfont
  1163. \let\code=\indexdummyfont
  1164. \let\file=\indexdummyfont
  1165. \let\samp=\indexdummyfont
  1166. \let\kbd=\indexdummyfont
  1167. \let\key=\indexdummyfont
  1168. \let\var=\indexdummyfont
  1169. \let\TeX=\indexdummytex
  1170. \let\dots=\indexdummydots
  1171. % To define \realbackslash, we must make \ not be an escape.
  1172. % We must first make another character (@) an escape
  1173. % so we do not become unable to do a definition.
  1174. {\catcode`\@=0 \catcode`\\=\other
  1175. @gdef@realbackslash{\}}
  1176. \let\indexbackslash=0  %overridden during \printindex.
  1177. \def\doind #1#2{%
  1178. {\count10=\lastpenalty %
  1179. {\indexdummies % Must do this here, since \bf, etc expand at this stage
  1180. \escapechar=`\\%
  1181. {\let\folio=0% Expand all macros now EXCEPT \folio
  1182. \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
  1183. % so it will be output as is; and it will print as backslash in the indx.
  1184. % Now process the index-string once, with all font commands turned off,
  1185. % to get the string to sort the index by.
  1186. {\indexnofonts
  1187. \xdef\temp1{#2}%
  1188. % Now produce the complete index entry.  We process the index-string again,
  1189. % this time with font commands expanded, to get what to print in the index.
  1190. \edef\temp{%
  1191. \write \csname#1indfile\endcsname{%
  1192. \realbackslash entry {\temp1}{\folio}{#2}}}%
  1193. \temp }%
  1194. }\penalty\count10}}
  1195. \def\dosubind #1#2#3{%
  1196. {\count10=\lastpenalty %
  1197. {\indexdummies % Must do this here, since \bf, etc expand at this stage
  1198. \escapechar=`\\%
  1199. {\let\folio=0%
  1200. \def\rawbackslashxx{\indexbackslash}%
  1201. % Now process the index-string once, with all font commands turned off,
  1202. % to get the string to sort the index by.
  1203. {\indexnofonts
  1204. \xdef\temp1{#2 #3}%
  1205. % Now produce the complete index entry.  We process the index-string again,
  1206. % this time with font commands expanded, to get what to print in the index.
  1207. \edef\temp{%
  1208. \write \csname#1indfile\endcsname{%
  1209. \realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
  1210. \temp }%
  1211. }\penalty\count10}}
  1212. % The index entry written in the file actually looks like
  1213. %  \entry {sortstring}{page}{topic}
  1214. %  \entry {sortstring}{page}{topic}{subtopic}
  1215. % The texindex program reads in these files and writes files
  1216. % containing these kinds of lines:
  1217. %  \initial {c}
  1218. %     before the first topic whose initial is c
  1219. %  \entry {topic}{pagelist}
  1220. %     for a topic that is used without subtopics
  1221. %  \primary {topic}
  1222. %     for the beginning of a topic that is used with subtopics
  1223. %  \secondary {subtopic}{pagelist}
  1224. %     for each subtopic.
  1225. % Define the user-accessible indexing commands 
  1226. % @findex, @vindex, @kindex, @cindex.
  1227. \def\findex {\fnindex}
  1228. \def\kindex {\kyindex}
  1229. \def\cindex {\cpindex}
  1230. \def\vindex {\vrindex}
  1231. \def\tindex {\tpindex}
  1232. \def\pindex {\pgindex}
  1233. \def\cindexsub {\begingroup\obeylines\cindexsub}
  1234. {\obeylines %
  1235. \gdef\cindexsub "#1" #2^^M{\endgroup %
  1236. \dosubind{cp}{#2}{#1}}}
  1237. % Define the macros used in formatting output of the sorted index material.
  1238. % This is what you call to cause a particular index to get printed.
  1239. % Write
  1240. % @unnumbered Function Index
  1241. % @printindex fn
  1242. \def\printindex{\parsearg\doprintindex}
  1243. \def\doprintindex#1{%
  1244.   \tex
  1245.   \dobreak \chapheadingskip {10000}
  1246.   \catcode`\%=\other\catcode`\&=\other\catcode`\#=\other
  1247.   \catcode`\$=\other\catcode`\_=\other
  1248.   \catcode`\~=\other
  1249.   % The following don't help, since the chars were translated
  1250.   % when the raw index was written, and their fonts were discarded
  1251.   % due to \indexnofonts.
  1252.   %\catcode`\"=\active
  1253.   %\catcode`\^=\active
  1254.   %\catcode`\_=\active
  1255.   %\catcode`\|=\active
  1256.   %\catcode`\<=\active
  1257.   %\catcode`\>=\active
  1258.   % %
  1259.   \def\indexbackslash{\rawbackslashxx}
  1260.   \indexfonts\rm \tolerance=9500 \advance\baselineskip -1pt
  1261.   \begindoublecolumns
  1262.   % See if the index file exists and is nonempty.
  1263.   \openin 1 \jobname.#1s
  1264.   \ifeof 1 
  1265.     % \enddoublecolumns gets confused if there is no text in the index,
  1266.     % and it loses the chapter title and the aux file entries for the
  1267.     % index.  The easiest way to prevent this problem is to make sure
  1268.     % there is some text.
  1269.     (Index is nonexistent)
  1270.     \else
  1271.     %
  1272.     % If the index file exists but is empty, then \openin leaves \ifeof
  1273.     % false.  We have to make TeX try to read something from the file, so
  1274.     % it can discover if there is anything in it.
  1275.     \read 1 to \temp
  1276.     \ifeof 1
  1277.       (Index is empty)
  1278.     \else
  1279.       \input \jobname.#1s
  1280.     \fi
  1281.   \fi
  1282.   \closein 1
  1283.   \enddoublecolumns
  1284.   \Etex
  1285. % These macros are used by the sorted index file itself.
  1286. % Change them to control the appearance of the index.
  1287. % Same as \bigskipamount except no shrink.
  1288. % \balancecolumns gets confused if there is any shrink.
  1289. \newskip\initialskipamount \initialskipamount 12pt plus4pt
  1290. \def\initial #1{%
  1291. {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
  1292. \ifdim\lastskip<\initialskipamount
  1293. \removelastskip \penalty-200 \vskip \initialskipamount\fi
  1294. \line{\secbf#1\hfill}\kern 2pt\penalty10000}}
  1295. % This typesets a paragraph consisting of #1, dot leaders, and then #2
  1296. % flush to the right margin.  It is used for index and table of contents
  1297. % entries.  The paragraph is indented by \leftskip.
  1298. \def\entry #1#2{\begingroup
  1299.   % Start a new paragraph if necessary, so our assignments below can't
  1300.   % affect previous text.
  1301.   \par
  1302.   % Do not fill out the last line with white space.
  1303.   \parfillskip = 0in
  1304.   % No extra space above this paragraph.
  1305.   \parskip = 0in
  1306.   % Do not prefer a separate line ending with a hyphen to fewer lines.
  1307.   \finalhyphendemerits = 0
  1308.   % \hangindent is only relevant when the entry text and page number
  1309.   % don't both fit on one line.  In that case, bob suggests starting the
  1310.   % dots pretty far over on the line.  Unfortunately, a large
  1311.   % indentation looks wrong when the entry text itself is broken across
  1312.   % lines.  So we use a small indentation and put up with long leaders.
  1313.   % \hangafter is reset to 1 (which is the value we want) at the start
  1314.   % of each paragraph, so we need not do anything with that.
  1315.   \hangindent=2em
  1316.   % When the entry text needs to be broken, just fill out the first line
  1317.   % with blank space.
  1318.   \rightskip = 0pt plus1fil
  1319.   % Start a ``paragraph'' for the index entry so the line breaking
  1320.   % parameters we've set above will have an effect.
  1321.   \noindent
  1322.   % Insert the text of the index entry.  TeX will do line-breaking on it.
  1323.   #1%
  1324.   % If we must, put the page number on a line of its own, and fill out
  1325.   % this line with blank space.  (The \hfil is overwhelmed with the
  1326.   % fill leaders glue in \indexdotfill if the page number does fit.)
  1327.   \hfil\penalty50
  1328.   \null\nobreak\indexdotfill % Have leaders before the page number.
  1329.   % The `\ ' here is removed by the implicit \unskip that TeX does as
  1330.   % part of (the primitive) \par.  Without it, a spurious underfull
  1331.   % \hbox ensues.
  1332.   \ #2% The page number ends the paragraph.
  1333.   \par
  1334. \endgroup}
  1335. % Like \dotfill except takes at least 1 em.
  1336. \def\indexdotfill{\cleaders
  1337.   \hbox{$\mathsurround=0pt \mkern1.5mu . \mkern1.5mu$}\hskip 1em plus 1fill}
  1338. \def\primary #1{\line{#1\hfil}}
  1339. \newskip\secondaryindent \secondaryindent=0.5cm
  1340. \def\secondary #1#2{
  1341. {\parfillskip=0in \parskip=0in
  1342. \hangindent =1in \hangafter=1
  1343. \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
  1344. %% Define two-column mode, which is used in indexes.
  1345. %% Adapted from the TeXbook, page 416.
  1346. \catcode `\@=11
  1347. \newbox\partialpage
  1348. \newdimen\doublecolumnhsize
  1349. \newdimen\availdimen@
  1350. \def\begindoublecolumns{\begingroup
  1351.   % Grab any single-column material above us.
  1352.   \output = {\global\setbox\partialpage
  1353.     =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
  1354.   \eject
  1355.   % Now switch to the double-column output routine.
  1356.   \output={\doublecolumnout}%
  1357.   % Change the page size parameters.  We could do this once outside this
  1358.   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
  1359.   % format, but then we repeat the same computation.  Repeating a couple
  1360.   % of assignments once per index is clearly meaningless for the
  1361.   % execution time, so we may as well do it once.
  1362.   % First we halve the line length, less a little for the gutter between
  1363.   % the columns.  We compute the gutter based on the line length, so it
  1364.   % changes automatically with the paper format.  The magic constant
  1365.   % below is chosen so that the gutter has the same value (well, +- <
  1366.   % 1pt) as it did when we hard-coded it.
  1367.   % We put the result in a separate register, \doublecolumhsize, so we
  1368.   % can restore it in \pagesofar, after \hsize itself has (potentially)
  1369.   % been clobbered.
  1370.   \doublecolumnhsize = \hsize
  1371.     \advance\doublecolumnhsize by -.04154\hsize
  1372.     \divide\doublecolumnhsize by 2
  1373.   \hsize = \doublecolumnhsize
  1374.   % Double the \vsize as well.  (We don't need a separate register here,
  1375.   % since nobody clobbers \vsize.)
  1376.   \vsize = 2\vsize
  1377. \def\enddoublecolumns{\output={\balancecolumns}\eject
  1378.   \endgroup \pagegoal=\vsize}
  1379. \def\doublecolumnout{\splittopskip=\topskip \splitmaxdepth=\maxdepth
  1380.   \dimen@=\pageheight \advance\dimen@ by-\ht\partialpage
  1381.   \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
  1382.   \onepageout\pagesofar \unvbox255 \penalty\outputpenalty}
  1383. \def\pagesofar{\unvbox\partialpage %
  1384.   \hsize=\doublecolumnhsize % have to restore this since output routine
  1385. %          changes it to set cropmarks (P. A. MacKay, 12 Nov. 1986)
  1386.   \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
  1387. \def\balancecolumns{%
  1388. % Unset the glue.
  1389.   \setbox255=\vbox{\unvbox255}
  1390.   \dimen@=\ht255
  1391.   \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
  1392.   \divide\dimen@ by2
  1393.   \availdimen@=\pageheight \advance\availdimen@ by-\ht\partialpage
  1394. % If the remaining data is too big for one page,
  1395. % output one page normally, then work with what remains.
  1396.   \ifdim \dimen@>\availdimen@
  1397.      \splittopskip=\topskip \splitmaxdepth=\maxdepth
  1398.      \dimen@=\pageheight \advance\dimen@ by-\ht\partialpage
  1399.      \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
  1400.      \onepageout\pagesofar
  1401. % Recompute size of what remains, in case we just output some of it.
  1402.   \dimen@=\ht255
  1403.   \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
  1404.   \divide\dimen@ by2
  1405.   \fi
  1406.   \setbox0=\vbox{\unvbox255}
  1407.   \splittopskip=\topskip
  1408.   {\vbadness=10000 \loop \global\setbox3=\copy0
  1409.     \global\setbox1=\vsplit3 to\dimen@
  1410.     \ifdim\ht3>\dimen@ \global\advance\dimen@ by1pt \repeat}
  1411.   \setbox0=\vbox to\dimen@{\unvbox1}  \setbox2=\vbox to\dimen@{\unvbox3}
  1412.   \pagesofar}
  1413. \catcode `\@=\other
  1414. \message{sectioning,}
  1415. % Define chapters, sections, etc.
  1416. \newcount \chapno
  1417. \newcount \secno        \secno=0
  1418. \newcount \subsecno     \subsecno=0
  1419. \newcount \subsubsecno  \subsubsecno=0
  1420. % This counter is funny since it counts through charcodes of letters A, B, ...
  1421. \newcount \appendixno  \appendixno = `\@
  1422. \def\appendixletter{\char\the\appendixno}
  1423. \newwrite \contentsfile
  1424. % This is called from \setfilename.
  1425. \def\opencontents{\openout \contentsfile = \jobname.toc}
  1426. % Each @chapter defines this as the name of the chapter.
  1427. % page headings and footings can use it.  @section does likewise
  1428. \def\thischapter{} \def\thissection{}
  1429. \def\seccheck#1{\if \pageno<0 %
  1430. \errmessage{@#1 not allowed after generating table of contents}\fi
  1431. \def\chapternofonts{%
  1432. \let\rawbackslash=\relax%
  1433. \let\frenchspacing=\relax%
  1434. \def\result{\realbackslash result}
  1435. \def\equiv{\realbackslash equiv}
  1436. \def\expansion{\realbackslash expansion}
  1437. \def\print{\realbackslash print}
  1438. \def\TeX{\realbackslash TeX}
  1439. \def\dots{\realbackslash dots}
  1440. \def\copyright{\realbackslash copyright}
  1441. \def\tt{\realbackslash tt}
  1442. \def\bf{\realbackslash bf }
  1443. \def\w{\realbackslash w}
  1444. \def\less{\realbackslash less}
  1445. \def\gtr{\realbackslash gtr}
  1446. \def\hat{\realbackslash hat}
  1447. \def\char{\realbackslash char}
  1448. \def\tclose##1{\realbackslash tclose {##1}}
  1449. \def\code##1{\realbackslash code {##1}}
  1450. \def\samp##1{\realbackslash samp {##1}}
  1451. \def\r##1{\realbackslash r {##1}}
  1452. \def\b##1{\realbackslash b {##1}}
  1453. \def\key##1{\realbackslash key {##1}}
  1454. \def\file##1{\realbackslash file {##1}}
  1455. \def\kbd##1{\realbackslash kbd {##1}}
  1456. % These are redefined because @smartitalic wouldn't work inside xdef.
  1457. \def\i##1{\realbackslash i {##1}}
  1458. \def\cite##1{\realbackslash cite {##1}}
  1459. \def\var##1{\realbackslash var {##1}}
  1460. \def\emph##1{\realbackslash emph {##1}}
  1461. \def\dfn##1{\realbackslash dfn {##1}}
  1462. \def\thischaptername{No Chapter Title}
  1463. \outer\def\chapter{\parsearg\chapterzzz}
  1464. \def\chapterzzz #1{\seccheck{chapter}%
  1465. \secno=0 \subsecno=0 \subsubsecno=0
  1466. \global\advance \chapno by 1 \message{Chapter \the\chapno}%
  1467. \chapmacro {#1}{\the\chapno}%
  1468. \gdef\thissection{#1}%
  1469. \gdef\thischaptername{#1}%
  1470. % We don't substitute the actual chapter name into \thischapter
  1471. % because we don't want its macros evaluated now.
  1472. \xdef\thischapter{Chapter \the\chapno: \noexpand\thischaptername}%
  1473. {\chapternofonts%
  1474. \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
  1475. \escapechar=`\\%
  1476. \write \contentsfile \temp  %
  1477. \donoderef %
  1478. \global\let\section = \numberedsec
  1479. \global\let\subsection = \numberedsubsec
  1480. \global\let\subsubsection = \numberedsubsubsec
  1481. \outer\def\appendix{\parsearg\appendixzzz}
  1482. \def\appendixzzz #1{\seccheck{appendix}%
  1483. \secno=0 \subsecno=0 \subsubsecno=0
  1484. \global\advance \appendixno by 1 \message{Appendix \appendixletter}%
  1485. \chapmacro {#1}{Appendix \appendixletter}%
  1486. \gdef\thissection{#1}%
  1487. \gdef\thischaptername{#1}%
  1488. \xdef\thischapter{Appendix \appendixletter: \noexpand\thischaptername}%
  1489. {\chapternofonts%
  1490. \edef\temp{{\realbackslash chapentry 
  1491.   {#1}{Appendix \appendixletter}{\noexpand\folio}}}%
  1492. \escapechar=`\\%
  1493. \write \contentsfile \temp  %
  1494. \appendixnoderef %
  1495. \global\let\section = \appendixsec
  1496. \global\let\subsection = \appendixsubsec
  1497. \global\let\subsubsection = \appendixsubsubsec
  1498. \outer\def\top{\parsearg\unnumberedzzz}
  1499. \outer\def\unnumbered{\parsearg\unnumberedzzz}
  1500. \def\unnumberedzzz #1{\seccheck{unnumbered}%
  1501. \secno=0 \subsecno=0 \subsubsecno=0
  1502. % This used to be simply \message{#1}, but TeX fully expands the
  1503. % argument to \message.  Therefore, if #1 contained @-commands, TeX
  1504. % expanded them.  For example, in `@unnumbered The @cite{Book}', TeX
  1505. % expanded @cite (which turns out to cause errors because \cite is meant
  1506. % to be executed, not expanded).  
  1507. % Anyway, we don't want the fully-expanded definition of @cite to appear
  1508. % as a result of the \message, we just want `@cite' itself.  We use
  1509. % \the<toks register> to achieve this: TeX expands \the<toks> only once,
  1510. % simply yielding the contents of the <toks register>.
  1511. \toks0 = {#1}\message{(\the\toks0)}%
  1512. \unnumbchapmacro {#1}%
  1513. \gdef\thischapter{#1}\gdef\thissection{#1}%
  1514. {\chapternofonts%
  1515. \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
  1516. \escapechar=`\\%
  1517. \write \contentsfile \temp  %
  1518. \unnumbnoderef %
  1519. \global\let\section = \unnumberedsec
  1520. \global\let\subsection = \unnumberedsubsec
  1521. \global\let\subsubsection = \unnumberedsubsubsec
  1522. \outer\def\numberedsec{\parsearg\seczzz}
  1523. \def\seczzz #1{\seccheck{section}%
  1524. \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
  1525. \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
  1526. {\chapternofonts%
  1527. \edef\temp{{\realbackslash secentry %
  1528. {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
  1529. \escapechar=`\\%
  1530. \write \contentsfile \temp %
  1531. \donoderef %
  1532. \penalty 10000 %
  1533. \outer\def\appendixsection{\parsearg\appendixsectionzzz}
  1534. \outer\def\appendixsec{\parsearg\appendixsectionzzz}
  1535. \def\appendixsectionzzz #1{\seccheck{appendixsection}%
  1536. \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
  1537. \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
  1538. {\chapternofonts%
  1539. \edef\temp{{\realbackslash secentry %
  1540. {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
  1541. \escapechar=`\\%
  1542. \write \contentsfile \temp %
  1543. \appendixnoderef %
  1544. \penalty 10000 %
  1545. \outer\def\unnumberedsec{\parsearg\unnumberedseczzz}
  1546. \def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
  1547. \plainsecheading {#1}\gdef\thissection{#1}%
  1548. {\chapternofonts%
  1549. \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
  1550. \escapechar=`\\%
  1551. \write \contentsfile \temp %
  1552. \unnumbnoderef %
  1553. \penalty 10000 %
  1554. \outer\def\numberedsubsec{\parsearg\numberedsubseczzz}
  1555. \def\numberedsubseczzz #1{\seccheck{subsection}%
  1556. \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
  1557. \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
  1558. {\chapternofonts%
  1559. \edef\temp{{\realbackslash subsecentry %
  1560. {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
  1561. \escapechar=`\\%
  1562. \write \contentsfile \temp %
  1563. \donoderef %
  1564. \penalty 10000 %
  1565. \outer\def\appendixsubsec{\parsearg\appendixsubseczzz}
  1566. \def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
  1567. \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
  1568. \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
  1569. {\chapternofonts%
  1570. \edef\temp{{\realbackslash subsecentry %
  1571. {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
  1572. \escapechar=`\\%
  1573. \write \contentsfile \temp %
  1574. \appendixnoderef %
  1575. \penalty 10000 %
  1576. \outer\def\unnumberedsubsec{\parsearg\unnumberedsubseczzz}
  1577. \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
  1578. \plainsecheading {#1}\gdef\thissection{#1}%
  1579. {\chapternofonts%
  1580. \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
  1581. \escapechar=`\\%
  1582. \write \contentsfile \temp %
  1583. \unnumbnoderef %
  1584. \penalty 10000 %
  1585. \outer\def\numberedsubsubsec{\parsearg\numberedsubsubseczzz}
  1586. \def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
  1587. \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
  1588. \subsubsecheading {#1}
  1589.   {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
  1590. {\chapternofonts%
  1591. \edef\temp{{\realbackslash subsubsecentry %
  1592.   {#1}
  1593.   {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
  1594.   {\noexpand\folio}}}%
  1595. \escapechar=`\\%
  1596. \write \contentsfile \temp %
  1597. \donoderef %
  1598. \penalty 10000 %
  1599. \outer\def\appendixsubsubsec{\parsearg\appendixsubsubseczzz}
  1600. \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
  1601. \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
  1602. \subsubsecheading {#1}
  1603.   {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
  1604. {\chapternofonts%
  1605. \edef\temp{{\realbackslash subsubsecentry{#1}%
  1606.   {\appendixletter}
  1607.   {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
  1608. \escapechar=`\\%
  1609. \write \contentsfile \temp %
  1610. \appendixnoderef %
  1611. \penalty 10000 %
  1612. \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
  1613. \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
  1614. \plainsecheading {#1}\gdef\thissection{#1}%
  1615. {\chapternofonts%
  1616. \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
  1617. \escapechar=`\\%
  1618. \write \contentsfile \temp %
  1619. \unnumbnoderef %
  1620. \penalty 10000 %
  1621. % These are variants which are not "outer", so they can appear in @ifinfo.
  1622. % Actually, they should now be obsolete; ordinary section commands should work.
  1623. \def\infotop{\parsearg\unnumberedzzz}
  1624. \def\infounnumbered{\parsearg\unnumberedzzz}
  1625. \def\infounnumberedsec{\parsearg\unnumberedseczzz}
  1626. \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
  1627. \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
  1628. \def\infoappendix{\parsearg\appendixzzz}
  1629. \def\infoappendixsec{\parsearg\appendixseczzz}
  1630. \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
  1631. \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
  1632. \def\infochapter{\parsearg\chapterzzz}
  1633. \def\infosection{\parsearg\sectionzzz}
  1634. \def\infosubsection{\parsearg\subsectionzzz}
  1635. \def\infosubsubsection{\parsearg\subsubsectionzzz}
  1636. % These macros control what the section commands do, according
  1637. % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
  1638. % Define them by default for a numbered chapter.
  1639. \global\let\section = \numberedsec
  1640. \global\let\subsection = \numberedsubsec
  1641. \global\let\subsubsection = \numberedsubsubsec
  1642. % Define @majorheading, @heading and @subheading
  1643. % NOTE on use of \vbox for chapter headings, section headings, and
  1644. % such:
  1645. %    1) We use \vbox rather than the earlier \line to permit
  1646. %       overlong headings to fold.
  1647. %    2) \hyphenpenalty is set to 10000 because hyphenation in a
  1648. %       heading is obnoxious; this forbids it.
  1649. %       3) Likewise, headings look best if no \parindent is used, and
  1650. %          if justification is not attempted.  Hence \raggedright.
  1651. \def\majorheading{\parsearg\majorheadingzzz}
  1652. \def\majorheadingzzz #1{%
  1653. {\advance\chapheadingskip by 10pt \chapbreak }%
  1654. {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1655.                   \parindent=0pt\raggedright
  1656.                   \rm #1\hfill}}\bigskip \par\penalty 200}
  1657. \def\chapheading{\parsearg\chapheadingzzz}
  1658. \def\chapheadingzzz #1{\chapbreak %
  1659. {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1660.                   \parindent=0pt\raggedright
  1661.                   \rm #1\hfill}}\bigskip \par\penalty 200}
  1662. \def\heading{\parsearg\secheadingi}
  1663. \def\subheading{\parsearg\subsecheadingi}
  1664. \def\subsubheading{\parsearg\subsubsecheadingi}
  1665. % These macros generate a chapter, section, etc. heading only
  1666. % (including whitespace, linebreaking, etc. around it),
  1667. % given all the information in convenient, parsed form.
  1668. %%% Args are the skip and penalty (usually negative)
  1669. \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
  1670. \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
  1671. %%% Define plain chapter starts, and page on/off switching for it
  1672. % Parameter controlling skip before chapter headings (if needed)
  1673. \newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
  1674. \def\chapbreak{\dobreak \chapheadingskip {-4000}}
  1675. \def\chappager{\par\vfill\supereject}
  1676. \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
  1677. \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
  1678. \def\CHAPPAGoff{
  1679. \global\let\pchapsepmacro=\chapbreak
  1680. \global\let\pagealignmacro=\chappager}
  1681. \def\CHAPPAGon{
  1682. \global\let\pchapsepmacro=\chappager
  1683. \global\let\pagealignmacro=\chappager
  1684. \global\def\HEADINGSon{\HEADINGSsingle}}
  1685. \def\CHAPPAGodd{
  1686. \global\let\pchapsepmacro=\chapoddpage
  1687. \global\let\pagealignmacro=\chapoddpage
  1688. \global\def\HEADINGSon{\HEADINGSdouble}}
  1689. \CHAPPAGon
  1690. \def\CHAPFplain{
  1691. \global\let\chapmacro=\chfplain
  1692. \global\let\unnumbchapmacro=\unnchfplain}
  1693. \def\chfplain #1#2{%
  1694.   \pchapsepmacro
  1695.     \chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1696.                      \parindent=0pt\raggedright
  1697.                      \rm #2\enspace #1}%
  1698.   \bigskip
  1699.   \penalty5000
  1700. \def\unnchfplain #1{%
  1701. \pchapsepmacro %
  1702. {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1703.                   \parindent=0pt\raggedright
  1704.                   \rm #1\hfill}}\bigskip \par\penalty 10000 %
  1705. \CHAPFplain % The default
  1706. \def\unnchfopen #1{%
  1707. \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1708.                        \parindent=0pt\raggedright
  1709.                        \rm #1\hfill}}\bigskip \par\penalty 10000 %
  1710. \def\chfopen #1#2{\chapoddpage {\chapfonts
  1711. \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
  1712. \par\penalty 5000 %
  1713. \def\CHAPFopen{
  1714. \global\let\chapmacro=\chfopen
  1715. \global\let\unnumbchapmacro=\unnchfopen}
  1716. % Parameter controlling skip before section headings.
  1717. \newskip \subsecheadingskip  \subsecheadingskip = 17pt plus 8pt minus 4pt
  1718. \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
  1719. \newskip \secheadingskip  \secheadingskip = 21pt plus 8pt minus 4pt
  1720. \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
  1721. % @paragraphindent  is defined for the Info formatting commands only.
  1722. \let\paragraphindent=\comment
  1723. % Section fonts are the base font at magstep2, which produces
  1724. % a size a bit more than 14 points in the default situation.    
  1725. \def\secheading #1#2#3{\secheadingi {#2.#3\enspace #1}}
  1726. \def\plainsecheading #1{\secheadingi {#1}}
  1727. \def\secheadingi #1{{\advance \secheadingskip by \parskip %
  1728. \secheadingbreak}%
  1729. {\secfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1730.                  \parindent=0pt\raggedright
  1731.                  \rm #1\hfill}}%
  1732. \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
  1733. % Subsection fonts are the base font at magstep1, 
  1734. % which produces a size of 12 points.
  1735. \def\subsecheading #1#2#3#4{\subsecheadingi {#2.#3.#4\enspace #1}}
  1736. \def\subsecheadingi #1{{\advance \subsecheadingskip by \parskip %
  1737. \subsecheadingbreak}%
  1738. {\subsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1739.                      \parindent=0pt\raggedright
  1740.                      \rm #1\hfill}}%
  1741. \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
  1742. \def\subsubsecfonts{\subsecfonts} % Maybe this should change:
  1743.                   % Perhaps make sssec fonts scaled
  1744.                   % magstep half
  1745. \def\subsubsecheading #1#2#3#4#5{\subsubsecheadingi {#2.#3.#4.#5\enspace #1}}
  1746. \def\subsubsecheadingi #1{{\advance \subsecheadingskip by \parskip %
  1747. \subsecheadingbreak}%
  1748. {\subsubsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
  1749.                        \parindent=0pt\raggedright
  1750.                        \rm #1\hfill}}%
  1751. \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000}
  1752. \message{toc printing,}
  1753. % Finish up the main text and prepare to read what we've written
  1754. % to \contentsfile.
  1755. \newskip\contentsrightmargin \contentsrightmargin=1in
  1756. \def\startcontents#1{%
  1757.    \pagealignmacro
  1758.    \immediate\closeout \contentsfile
  1759.    \ifnum \pageno>0
  1760.       \pageno = -1        % Request roman numbered pages.
  1761.    \fi
  1762.    % Don't need to put `Contents' or `Short Contents' in the headline. 
  1763.    % It is abundantly clear what they are.
  1764.    \unnumbchapmacro{#1}\def\thischapter{}%
  1765.    \begingroup           % Set up to handle contents files properly.
  1766.       \catcode`\\=0  \catcode`\{=1  \catcode`\}=2  \catcode`\@=11
  1767.       \raggedbottom             % Worry more about breakpoints than the bottom.
  1768.       \advance\hsize by -\contentsrightmargin % Don't use the full line length.
  1769. % Normal (long) toc.
  1770. \outer\def\contents{%
  1771.    \startcontents{Table of Contents}%
  1772.       \input \jobname.toc
  1773.    \endgroup
  1774.    \vfill \eject
  1775. % And just the chapters.
  1776. \outer\def\summarycontents{%
  1777.    \startcontents{Short Contents}%
  1778.       %
  1779.       \let\chapentry = \shortchapentry
  1780.       \let\unnumbchapentry = \shortunnumberedentry
  1781.       % We want a true roman here for the page numbers.
  1782.       \secfonts
  1783.       \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
  1784.       \rm
  1785.       \advance\baselineskip by 1pt % Open it up a little.
  1786.       \def\secentry ##1##2##3##4{}
  1787.       \def\unnumbsecentry ##1##2{}
  1788.       \def\subsecentry ##1##2##3##4##5{}
  1789.       \def\unnumbsubsecentry ##1##2{}
  1790.       \def\subsubsecentry ##1##2##3##4##5##6{}
  1791.       \def\unnumbsubsubsecentry ##1##2{}
  1792.       \input \jobname.toc
  1793.    \endgroup
  1794.    \vfill \eject
  1795. \let\shortcontents = \summarycontents
  1796. % These macros generate individual entries in the table of contents.
  1797. % The first argument is the chapter or section name.
  1798. % The last argument is the page number.
  1799. % The arguments in between are the chapter number, section number, ...
  1800. % Chapter-level things, for both the long and short contents.
  1801. \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
  1802. % See comments in \dochapentry re vbox and related settings
  1803. \def\shortchapentry#1#2#3{%
  1804.   \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
  1805. % Typeset the label for a chapter or appendix for the short contents.
  1806. % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
  1807. % We could simplify the code here by writing out an \appendixentry
  1808. % command in the toc file for appendices, instead of using \chapentry
  1809. % for both, but it doesn't seem worth it.
  1810. \setbox0 = \hbox{\shortcontrm Appendix }
  1811. \newdimen\shortappendixwidth \shortappendixwidth = \wd0
  1812. \def\shortchaplabel#1{%
  1813.   % We typeset #1 in a box of constant width, regardless of the text of
  1814.   % #1, so the chapter titles will come out aligned.
  1815.   \setbox0 = \hbox{#1}%
  1816.   \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
  1817.   % This space should be plenty, since a single number is .5em, and the
  1818.   % widest letter (M) is 1em, at least in the Computer Modern fonts.
  1819.   % (This space doesn't include the extra space that gets added after
  1820.   % the label; that gets put in in \shortchapentry above.)
  1821.   \advance\dimen0 by 1.1em
  1822.   \hbox to \dimen0{#1\hfil}%
  1823. \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
  1824. \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
  1825. % Sections.
  1826. \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
  1827. \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
  1828. % Subsections.
  1829. \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
  1830. \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
  1831. % And subsubsections.
  1832. \def\subsubsecentry#1#2#3#4#5#6{%
  1833.   \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
  1834. \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
  1835. % This parameter controls the indentation of the various levels.
  1836. \newdimen\tocindent \tocindent = 3pc
  1837. % Now for the actual typesetting. In all these, #1 is the text and #2 is the 
  1838. % page number.
  1839. % If the toc has to be broken over pages, we would want to be at chapters 
  1840. % if at all possible; hence the \penalty.
  1841. \def\dochapentry#1#2{%
  1842.    \penalty-300 \vskip\baselineskip
  1843.    \begingroup
  1844.      \chapentryfonts
  1845.      \tocentry{#1}{\dopageno{#2}}%
  1846.    \endgroup
  1847.    \nobreak\vskip .25\baselineskip
  1848. \def\dosecentry#1#2{\begingroup
  1849.   \secentryfonts \leftskip=\tocindent
  1850.   \tocentry{#1}{\dopageno{#2}}%
  1851. \endgroup}
  1852. \def\dosubsecentry#1#2{\begingroup
  1853.   \subsecentryfonts \leftskip=2\tocindent
  1854.   \tocentry{#1}{\dopageno{#2}}%
  1855. \endgroup}
  1856. \def\dosubsubsecentry#1#2{\begingroup
  1857.   \subsubsecentryfonts \leftskip=3\tocindent
  1858.   \tocentry{#1}{\dopageno{#2}}%
  1859. \endgroup}
  1860. % Final typesetting of a toc entry; we use the same \entry macro as for
  1861. % the index entries, but we want to suppress hyphenation here.  (We
  1862. % can't do that in the \entry macro, since index entries might consist
  1863. % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
  1864. \def\tocentry#1#2{\begingroup
  1865.   \hyphenpenalty = 10000
  1866.   \entry{#1}{#2}%
  1867. \endgroup}
  1868. % Space between chapter (or whatever) number and the title.
  1869. \def\labelspace{\hskip1em \relax}
  1870. \def\dopageno#1{{\rm #1}}
  1871. \def\doshortpageno#1{{\rm #1}}
  1872. \def\chapentryfonts{\secfonts \rm}
  1873. \def\secentryfonts{\textfonts}
  1874. \let\subsecentryfonts = \textfonts
  1875. \let\subsubsecentryfonts = \textfonts
  1876. \message{environments,}
  1877. % Since these characters are used in examples, it should be an even number of 
  1878. % \tt widths. Each \tt character is 1en, so two makes it 1em.
  1879. % Furthermore, these definitions must come after we define our fonts.
  1880. \newbox\dblarrowbox    \newbox\longdblarrowbox
  1881. \newbox\pushcharbox    \newbox\bullbox
  1882. \newbox\equivbox       \newbox\errorbox
  1883. \let\ptexequiv = \equiv
  1884. %{\tentt
  1885. %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
  1886. %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
  1887. %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
  1888. %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
  1889. % Adapted from the manmac format (p.420 of TeXbook)
  1890. %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
  1891. %                                      depth .1ex\hfil}
  1892. \def\point{$\star$}
  1893. \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
  1894. \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
  1895. \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
  1896. \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
  1897. % Adapted from the TeXbook's \boxit.
  1898. {\tentt \global\dimen0 = 3em}% Width of the box.
  1899. \dimen2 = .55pt % Thickness of rules
  1900. % The text. (`r' is open on the right, `e' somewhat less so on the left.)
  1901. \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
  1902. \global\setbox\errorbox=\hbox to \dimen0{\hfil
  1903.    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
  1904.    \advance\hsize by -2\dimen2 % Rules.
  1905.    \vbox{
  1906.       \hrule height\dimen2
  1907.       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
  1908.          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
  1909.          \kern3pt\vrule width\dimen2}% Space to right.
  1910.       \hrule height\dimen2}
  1911.     \hfil}
  1912. % The @error{} command.
  1913. \def\error{\leavevmode\lower.7ex\copy\errorbox}
  1914. % @tex ... @end tex    escapes into raw Tex temporarily.
  1915. % One exception: @ is still an escape character, so that @end tex works.
  1916. % But \@ or @@ will get a plain tex @ character.
  1917. \def\tex{\begingroup
  1918. \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
  1919. \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
  1920. \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
  1921. \catcode `\%=14
  1922. \catcode 43=12
  1923. \catcode`\"=12
  1924. \catcode`\==12
  1925. \catcode`\|=12
  1926. \catcode`\<=12
  1927. \catcode`\>=12
  1928. \escapechar=`\\
  1929. \let\{=\ptexlbrace
  1930. \let\}=\ptexrbrace
  1931. \let\.=\ptexdot
  1932. \let\*=\ptexstar
  1933. \let\dots=\ptexdots
  1934. \def\@{@}%
  1935. \let\bullet=\ptexbullet
  1936. \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
  1937. \let\L=\ptexL
  1938. \let\Etex=\endgroup}
  1939. % Define @lisp ... @endlisp.
  1940. % @lisp does a \begingroup so it can rebind things,
  1941. % including the definition of @endlisp (which normally is erroneous).
  1942. % Amount to narrow the margins by for @lisp.
  1943. \newskip\lispnarrowing \lispnarrowing=0.4in
  1944. % This is the definition that ^M gets inside @lisp
  1945. % phr: changed space to \null, to avoid overfull hbox problems.
  1946. {\obeyspaces%
  1947. \gdef\lisppar{\null\endgraf}}
  1948. % Cause \obeyspaces to make each Space cause a word-separation
  1949. % rather than the default which is that it acts punctuation.
  1950. % This is because space in tt font looks funny.
  1951. {\obeyspaces %
  1952. \gdef\sepspaces{\def {\ }}}
  1953. % This space is always present above and below environments.
  1954. \newskip\envskipamount \envskipamount = 0pt
  1955. % Make spacing and below environment symmetrical.
  1956. \def\aboveenvbreak{{\advance\envskipamount by \parskip
  1957. \endgraf \ifdim\lastskip<\envskipamount
  1958. \removelastskip \penalty-50 \vskip\envskipamount \fi}}
  1959. \let\afterenvbreak = \aboveenvbreak
  1960. % \nonarrowing is a flag.  If "set", @lisp etc don't narrow margins.
  1961. \let\nonarrowing=\relax
  1962. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  1963. % \cartouche: draw rectangle w/rounded corners around argument
  1964. \font\circle=lcircle10
  1965. \newdimen\circthick
  1966. \newdimen\cartouter\newdimen\cartinner
  1967. \newskip\normbskip\newskip\normpskip\newskip\normlskip
  1968. \circthick=\fontdimen8\circle
  1969. \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
  1970. \def\ctr{{\hskip 6pt\circle\char'010}}
  1971. \def\cbl{{\circle\char'012\hskip -6pt}}
  1972. \def\cbr{{\hskip 6pt\circle\char'011}}
  1973. \def\carttop{\hbox to \cartouter{\hskip\lskip
  1974.     \ctl\leaders\hrule height\circthick\hfil\ctr
  1975.     \hskip\rskip}}
  1976. \def\cartbot{\hbox to \cartouter{\hskip\lskip
  1977.     \cbl\leaders\hrule height\circthick\hfil\cbr
  1978.     \hskip\rskip}}
  1979. \newskip\lskip\newskip\rskip
  1980. \long\def\cartouche{%
  1981. \begingroup
  1982.     \lskip=\leftskip \rskip=\rightskip
  1983.     \leftskip=0pt\rightskip=0pt %we want these *outside*.
  1984.     \cartinner=\hsize \advance\cartinner by-\lskip 
  1985.                \advance\cartinner by-\rskip
  1986.     \cartouter=\hsize
  1987.     \advance\cartouter by 18pt % allow for 3pt kerns on either
  1988. %                     side, and for 6pt waste from
  1989. %                     each corner char
  1990.     \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
  1991.     % Flag to tell @lisp, etc., not to narrow margin.
  1992.     \let\nonarrowing=\comment
  1993.     \vbox\bgroup
  1994.         \baselineskip=0pt\parskip=0pt\lineskip=0pt
  1995.         \carttop
  1996.         \hbox\bgroup
  1997.             \hskip\lskip
  1998.             \vrule\kern3pt
  1999.             \vbox\bgroup
  2000.                 \hsize=\cartinner
  2001.                 \kern3pt
  2002.                 \begingroup
  2003.                     \baselineskip=\normbskip
  2004.                     \lineskip=\normlskip
  2005.                     \parskip=\normpskip
  2006.                     \vskip -\parskip
  2007. \def\Ecartouche{%
  2008.                 \endgroup
  2009.                 \kern3pt
  2010.             \egroup
  2011.             \kern3pt\vrule
  2012.             \hskip\rskip
  2013.         \egroup
  2014.         \cartbot
  2015.     \egroup
  2016. \endgroup
  2017. \def\lisp{\aboveenvbreak
  2018. \begingroup\inENV % This group ends at the end of the @lisp body
  2019. \hfuzz=12truept % Don't be fussy
  2020. % Make spaces be word-separators rather than space tokens.
  2021. \sepspaces %
  2022. % Single space lines
  2023. \singlespace %
  2024. % The following causes blank lines not to be ignored
  2025. % by adding a space to the end of each line.
  2026. \let\par=\lisppar
  2027. \def\Elisp{\endgroup\afterenvbreak}%
  2028. \parskip=0pt
  2029. % @cartouche defines \nonarrowing to inhibit narrowing
  2030. % at next level down.
  2031. \ifx\nonarrowing\relax
  2032. \advance \leftskip by \lispnarrowing
  2033. \exdentamount=\lispnarrowing
  2034. \let\exdent=\nofillexdent
  2035. \let\nonarrowing=\relax
  2036. \parindent=0pt
  2037. \obeyspaces \obeylines \tt \rawbackslash
  2038. \gobble
  2039. % Define the \E... control sequence only if we are inside the
  2040. % environment, so the error checking in \end will work.
  2041. % We must call \lisp last in the definition, since it reads the
  2042. % return following the @example (or whatever) command.
  2043. \def\example{\begingroup \def\Eexample{\Elisp\endgroup}\lisp}
  2044. \def\smallexample{\begingroup \def\Esmallexample{\Elisp\endgroup}\lisp}
  2045. % Macro for 9 pt. examples, necessary to print with 5" lines.
  2046. % From Pavel@xerox.  This is not really used unless the
  2047. % @smallbook command is given.
  2048. \def\smalllispx{\aboveenvbreak\begingroup\inENV
  2049. %            This group ends at the end of the @lisp body
  2050. \hfuzz=12truept % Don't be fussy
  2051. % Make spaces be word-separators rather than space tokens.
  2052. \sepspaces %
  2053. % Single space lines
  2054. \singlespace %
  2055. % The following causes blank lines not to be ignored
  2056. % by adding a space to the end of each line.
  2057. \let\par=\lisppar
  2058. \def\Esmalllisp{\endgroup\afterenvbreak}%
  2059. %%%% Smaller baseline skip for small examples.
  2060. \baselineskip 10pt
  2061. \parskip=0pt
  2062. % @cartouche defines \nonarrowing to inhibit narrowing
  2063. % at next level down.
  2064. \ifx\nonarrowing\relax
  2065. \advance \leftskip by \lispnarrowing
  2066. \exdentamount=\lispnarrowing
  2067. \let\exdent=\nofillexdent
  2068. \let\nonarrowing=\relax
  2069. \parindent=0pt
  2070. \obeyspaces \obeylines \ninett \indexfonts \rawbackslash
  2071. \def\next##1{}\next}
  2072. % This is @display; same as @lisp except use roman font.
  2073. \def\display{\begingroup\inENV %This group ends at the end of the @display body
  2074. \aboveenvbreak
  2075. % Make spaces be word-separators rather than space tokens.
  2076. \sepspaces %
  2077. % Single space lines
  2078. \singlespace %
  2079. % The following causes blank lines not to be ignored
  2080. % by adding a space to the end of each line.
  2081. \let\par=\lisppar
  2082. \def\Edisplay{\endgroup\afterenvbreak}%
  2083. \parskip=0pt
  2084. % @cartouche defines \nonarrowing to inhibit narrowing
  2085. % at next level down.
  2086. \ifx\nonarrowing\relax
  2087. \advance \leftskip by \lispnarrowing
  2088. \exdentamount=\lispnarrowing
  2089. \let\exdent=\nofillexdent
  2090. \let\nonarrowing=\relax
  2091. \parindent=0pt
  2092. \obeyspaces \obeylines
  2093. \def\next##1{}\next}
  2094. % This is @format; same as @lisp except use roman font and don't narrow margins
  2095. \def\format{\begingroup\inENV %This group ends at the end of the @format body
  2096. \aboveenvbreak
  2097. % Make spaces be word-separators rather than space tokens.
  2098. \sepspaces %
  2099. \singlespace %
  2100. % The following causes blank lines not to be ignored
  2101. % by adding a space to the end of each line.
  2102. \let\par=\lisppar
  2103. \def\Eformat{\endgroup\afterenvbreak}
  2104. \parskip=0pt \parindent=0pt
  2105. \obeyspaces \obeylines
  2106. \def\next##1{}\next}
  2107. % @flushleft and @flushright
  2108. \def\flushleft{%
  2109. \begingroup\inENV %This group ends at the end of the @format body
  2110. \aboveenvbreak
  2111. % Make spaces be word-separators rather than space tokens.
  2112. \sepspaces %
  2113. % The following causes blank lines not to be ignored
  2114. % by adding a space to the end of each line.
  2115. % This also causes @ to work when the directive name
  2116. % is terminated by end of line.
  2117. \let\par=\lisppar
  2118. \def\Eflushleft{\endgroup\afterenvbreak}%
  2119. \parskip=0pt \parindent=0pt
  2120. \obeyspaces \obeylines
  2121. \def\next##1{}\next}
  2122. \def\flushright{%
  2123. \begingroup\inENV %This group ends at the end of the @format body
  2124. \aboveenvbreak
  2125. % Make spaces be word-separators rather than space tokens.
  2126. \sepspaces %
  2127. % The following causes blank lines not to be ignored
  2128. % by adding a space to the end of each line.
  2129. % This also causes @ to work when the directive name
  2130. % is terminated by end of line.
  2131. \let\par=\lisppar
  2132. \def\Eflushright{\endgroup\afterenvbreak}%
  2133. \parskip=0pt \parindent=0pt
  2134. \advance \leftskip by 0pt plus 1fill
  2135. \obeyspaces \obeylines
  2136. \def\next##1{}\next}
  2137. % @quotation - narrow the margins.
  2138. \def\quotation{%
  2139. \begingroup\inENV %This group ends at the end of the @quotation body
  2140. {\parskip=0pt  % because we will skip by \parskip too, later
  2141. \aboveenvbreak}%
  2142. \singlespace
  2143. \parindent=0pt
  2144. \def\Equotation{\par\endgroup\afterenvbreak}%
  2145. % @cartouche defines \nonarrowing to inhibit narrowing
  2146. % at next level down.
  2147. \ifx\nonarrowing\relax
  2148. \advance \leftskip by \lispnarrowing
  2149. \advance \rightskip by \lispnarrowing
  2150. \exdentamount=\lispnarrowing
  2151. \let\nonarrowing=\relax
  2152. \message{defuns,}
  2153. % Define formatter for defuns
  2154. % First, allow user to change definition object font (\df) internally
  2155. \def\setdeffont #1 {\csname DEF#1\endcsname}
  2156. \newskip\defbodyindent \defbodyindent=.4in
  2157. \newskip\defargsindent \defargsindent=50pt
  2158. \newskip\deftypemargin \deftypemargin=12pt
  2159. \newskip\deflastargmargin \deflastargmargin=18pt
  2160. \newcount\parencount
  2161. % define \functionparens, which makes ( and ) and & do special things.
  2162. % \functionparens affects the group it is contained in.
  2163. \def\activeparens{%
  2164. \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
  2165. \catcode`\[=\active \catcode`\]=\active}
  2166. % Make control sequences which act like normal parenthesis chars.
  2167. \let\lparen = ( \let\rparen = )
  2168. {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
  2169. % Be sure that we always have a definition for `(', etc.  For example,
  2170. % if the fn name has parens in it, \boldbrax will not be in effect yet,
  2171. % so TeX would otherwise complain about undefined control sequence.
  2172. \global\let(=\lparen \global\let)=\rparen
  2173. \global\let[=\lbrack \global\let]=\rbrack
  2174. \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
  2175. \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
  2176. % Definitions of (, ) and & used in args for functions.
  2177. % This is the definition of ( outside of all parentheses.
  2178. \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
  2179. \global\advance\parencount by 1 }
  2180. % This is the definition of ( when already inside a level of parens.
  2181. \gdef\opnested{\char`\(\global\advance\parencount by 1 }
  2182. \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
  2183. % also in that case restore the outer-level definition of (.
  2184. \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
  2185. \global\advance \parencount by -1 }
  2186. % If we encounter &foo, then turn on ()-hacking afterwards
  2187. \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
  2188. \gdef\normalparens{\boldbrax\let&=\ampnr}
  2189. } % End of definition inside \activeparens
  2190. %% These parens (in \boldbrax) actually are a little bolder than the
  2191. %% contained text.  This is especially needed for [ and ]
  2192. \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
  2193. \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
  2194. % First, defname, which formats the header line itself.
  2195. % #1 should be the function name.
  2196. % #2 should be the type of definition, such as "Function".
  2197. \def\defname #1#2{%
  2198. % Get the values of \leftskip and \rightskip as they were
  2199. % outside the @def...
  2200. \dimen2=\leftskip
  2201. \advance\dimen2 by -\defbodyindent
  2202. \dimen3=\rightskip
  2203. \advance\dimen3 by -\defbodyindent
  2204. \noindent        %
  2205. \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
  2206. \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
  2207. \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
  2208. \parshape 2 0in \dimen0 \defargsindent \dimen1     %
  2209. % Now output arg 2 ("Function" or some such)
  2210. % ending at \deftypemargin from the right margin,
  2211. % but stuck inside a box of width 0 so it does not interfere with linebreaking
  2212. {% Adjust \hsize to exclude the ambient margins,
  2213. % so that \rightline will obey them.
  2214. \advance \hsize by -\dimen2 \advance \hsize by -\dimen3
  2215. \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
  2216. % Make all lines underfull and no complaints:
  2217. \tolerance=10000 \hbadness=10000    
  2218. \advance\leftskip by -\defbodyindent
  2219. \exdentamount=\defbodyindent
  2220. {\df #1}\enskip        % Generate function name
  2221. % Actually process the body of a definition
  2222. % #1 should be the terminating control sequence, such as \Edefun.
  2223. % #2 should be the "another name" control sequence, such as \defunx.
  2224. % #3 should be the control sequence that actually processes the header,
  2225. %    such as \defunheader.
  2226. \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
  2227. \medbreak %
  2228. % Define the end token that this defining construct specifies
  2229. % so that it will exit this group.
  2230. \def#1{\endgraf\endgroup\medbreak}%
  2231. \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
  2232. \parindent=0in
  2233. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2234. \exdentamount=\defbodyindent
  2235. \begingroup %
  2236. \catcode 61=\active %
  2237. \obeylines\activeparens\spacesplit#3}
  2238. \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
  2239. \medbreak %
  2240. % Define the end token that this defining construct specifies
  2241. % so that it will exit this group.
  2242. \def#1{\endgraf\endgroup\medbreak}%
  2243. \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
  2244. \parindent=0in
  2245. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2246. \exdentamount=\defbodyindent
  2247. \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
  2248. \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
  2249. \medbreak %
  2250. % Define the end token that this defining construct specifies
  2251. % so that it will exit this group.
  2252. \def#1{\endgraf\endgroup\medbreak}%
  2253. \def#2##1 ##2 {\def#4{##1}%
  2254. \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
  2255. \parindent=0in
  2256. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2257. \exdentamount=\defbodyindent
  2258. \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
  2259. % These parsing functions are similar to the preceding ones
  2260. % except that they do not make parens into active characters.
  2261. % These are used for "variables" since they have no arguments.
  2262. \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
  2263. \medbreak %
  2264. % Define the end token that this defining construct specifies
  2265. % so that it will exit this group.
  2266. \def#1{\endgraf\endgroup\medbreak}%
  2267. \def#2{\begingroup\obeylines\spacesplit#3}%
  2268. \parindent=0in
  2269. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2270. \exdentamount=\defbodyindent
  2271. \begingroup %
  2272. \catcode 61=\active %
  2273. \obeylines\spacesplit#3}
  2274. \def\defvrparsebody #1#2#3#4 {\begingroup\inENV %
  2275. \medbreak %
  2276. % Define the end token that this defining construct specifies
  2277. % so that it will exit this group.
  2278. \def#1{\endgraf\endgroup\medbreak}%
  2279. \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
  2280. \parindent=0in
  2281. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2282. \exdentamount=\defbodyindent
  2283. \begingroup\obeylines\spacesplit{#3{#4}}}
  2284. % This is the same as all the others except for the last line.  We need
  2285. % to parse the arguments differently for @deftp, since the ``attributes''
  2286. % there are optional.
  2287. \def\deftpparsebody #1#2#3#4 {\begingroup\inENV %
  2288. \medbreak %
  2289. % Define the end token that this defining construct specifies
  2290. % so that it will exit this group.
  2291. \def#1{\endgraf\endgroup\medbreak}%
  2292. \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
  2293. \parindent=0in
  2294. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2295. \exdentamount=\defbodyindent
  2296. \begingroup\obeylines\parsetpheaderline{#3{#4}}}
  2297. {\obeylines %
  2298.   % Parse the type name and any attributes (field names, etc.).
  2299.   % #1 is the beginning of the macro call that will produce the output,
  2300.   %   i.e., \deftpheader{CLASS}; this is passed from \deftpparsebody.
  2301.   % #2 is the type name, e.g., `struct termios'.
  2302.   % #3 is the (possibly empty) attribute list.
  2303.   \gdef\parsetpheaderline#1#2#3^^M{%
  2304.     \endgroup % Started in \deftpparsebody.
  2305.     %
  2306.     % If the attribute list is in fact empty, there will be no space after
  2307.     % #2; so we can't put a space in our TeX parameter list.  But if it
  2308.     % isn't empty, then #3 will begin with an unwanted space.
  2309.     \def\theargs{\ignorespaces #3}%
  2310.     %
  2311.     % Call the macro to produce the output.
  2312.     #1{#2}\theargs %
  2313. \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
  2314. \medbreak %
  2315. % Define the end token that this defining construct specifies
  2316. % so that it will exit this group.
  2317. \def#1{\endgraf\endgroup\medbreak}%
  2318. \def#2##1 ##2 {\def#4{##1}%
  2319. \begingroup\obeylines\spacesplit{#3{##2}}}%
  2320. \parindent=0in
  2321. \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
  2322. \exdentamount=\defbodyindent
  2323. \begingroup\obeylines\spacesplit{#3{#5}}}
  2324. % Split up #2 at the first space token.
  2325. % call #1 with two arguments:
  2326. %  the first is all of #2 before the space token,
  2327. %  the second is all of #2 after that space token.
  2328. % If #2 contains no space token, all of it is passed as the first arg
  2329. % and the second is passed as empty.
  2330. {\obeylines
  2331. \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
  2332. \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
  2333. \ifx\relax #3%
  2334. #1{#2}{}\else #1{#2}{#3#4}\fi}}
  2335. % So much for the things common to all kinds of definitions.
  2336. % Define @defun.
  2337. % First, define the processing that is wanted for arguments of \defun
  2338. % Use this to expand the args and terminate the paragraph they make up
  2339. \def\defunargs #1{\functionparens \sl
  2340. % Expand, preventing hyphenation at `-' chars.
  2341. % Note that groups don't affect changes in \hyphenchar.
  2342. \hyphenchar\tensl=0
  2343. \hyphenchar\tensl=45
  2344. \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
  2345. \interlinepenalty=10000
  2346. \advance\rightskip by 0pt plus 1fil
  2347. \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
  2348. \def\deftypefunargs #1{%
  2349. % Expand, preventing hyphenation at `-' chars.
  2350. % Note that groups don't affect changes in \hyphenchar.
  2351. \functionparens
  2352. \code{#1}%
  2353. \interlinepenalty=10000
  2354. \advance\rightskip by 0pt plus 1fil
  2355. \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
  2356. % Do complete processing of one @defun or @defunx line already parsed.
  2357. % @deffn Command forward-char nchars
  2358. \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
  2359. \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
  2360. \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
  2361. \catcode 61=\other % Turn off change made in \defparsebody
  2362. % @defun == @deffn Function
  2363. \def\defun{\defparsebody\Edefun\defunx\defunheader}
  2364. \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
  2365. \begingroup\defname {#1}{Function}%
  2366. \defunargs {#2}\endgroup %
  2367. \catcode 61=\other % Turn off change made in \defparsebody
  2368. % @deftypefun int foobar (int @var{foo}, float @var{bar})
  2369. \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
  2370. % #1 is the data type.  #2 is the name and args.
  2371. \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
  2372. % #1 is the data type, #2 the name, #3 the args.
  2373. \def\deftypefunheaderx #1#2 #3\relax{%
  2374. \doind {fn}{\code{#2}}% Make entry in function index
  2375. \begingroup\defname {\code{#1} #2}{Function}%
  2376. \deftypefunargs {#3}\endgroup %
  2377. \catcode 61=\other % Turn off change made in \defparsebody
  2378. % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
  2379. \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
  2380. % #1 is the classification.  #2 is the data type.  #3 is the name and args.
  2381. \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
  2382. % #1 is the classification, #2 the data type, #3 the name, #4 the args.
  2383. \def\deftypefnheaderx #1#2#3 #4\relax{%
  2384. \doind {fn}{\code{#3}}% Make entry in function index
  2385. \begingroup\defname {\code{#2} #3}{#1}%
  2386. \deftypefunargs {#4}\endgroup %
  2387. \catcode 61=\other % Turn off change made in \defparsebody
  2388. % @defmac == @deffn Macro
  2389. \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
  2390. \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
  2391. \begingroup\defname {#1}{Macro}%
  2392. \defunargs {#2}\endgroup %
  2393. \catcode 61=\other % Turn off change made in \defparsebody
  2394. % @defspec == @deffn Special Form
  2395. \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
  2396. \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
  2397. \begingroup\defname {#1}{Special Form}%
  2398. \defunargs {#2}\endgroup %
  2399. \catcode 61=\other % Turn off change made in \defparsebody
  2400. % This definition is run if you use @defunx
  2401. % anywhere other than immediately after a @defun or @defunx.
  2402. \def\deffnx #1 {\errmessage{@deffnx in invalid context}}
  2403. \def\defunx #1 {\errmessage{@defunx in invalid context}}
  2404. \def\defmacx #1 {\errmessage{@defmacx in invalid context}}
  2405. \def\defspecx #1 {\errmessage{@defspecx in invalid context}}
  2406. \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
  2407. \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
  2408. % @defmethod, and so on
  2409. % @defop {Funny Method} foo-class frobnicate argument
  2410. \def\defop #1 {\def\defoptype{#1}%
  2411. \defopparsebody\Edefop\defopx\defopheader\defoptype}
  2412. \def\defopheader #1#2#3{%
  2413. \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
  2414. \begingroup\defname {#2}{\defoptype{} on #1}%
  2415. \defunargs {#3}\endgroup %
  2416. % @defmethod == @defop Method
  2417. \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
  2418. \def\defmethodheader #1#2#3{%
  2419. \dosubind {fn}{\code{#2}}{on #1}% entry in function index
  2420. \begingroup\defname {#2}{Method on #1}%
  2421. \defunargs {#3}\endgroup %
  2422. % @defcv {Class Option} foo-class foo-flag
  2423. \def\defcv #1 {\def\defcvtype{#1}%
  2424. \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
  2425. \def\defcvarheader #1#2#3{%
  2426. \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
  2427. \begingroup\defname {#2}{\defcvtype{} of #1}%
  2428. \defvarargs {#3}\endgroup %
  2429. % @defivar == @defcv {Instance Variable}
  2430. \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
  2431. \def\defivarheader #1#2#3{%
  2432. \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
  2433. \begingroup\defname {#2}{Instance Variable of #1}%
  2434. \defvarargs {#3}\endgroup %
  2435. % These definitions are run if you use @defmethodx, etc.,
  2436. % anywhere other than immediately after a @defmethod, etc.
  2437. \def\defopx #1 {\errmessage{@defopx in invalid context}}
  2438. \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
  2439. \def\defcvx #1 {\errmessage{@defcvx in invalid context}}
  2440. \def\defivarx #1 {\errmessage{@defivarx in invalid context}}
  2441. % Now @defvar
  2442. % First, define the processing that is wanted for arguments of @defvar.
  2443. % This is actually simple: just print them in roman.
  2444. % This must expand the args and terminate the paragraph they make up
  2445. \def\defvarargs #1{\normalparens #1%
  2446. \interlinepenalty=10000
  2447. \endgraf\penalty 10000\vskip -\parskip\penalty 10000}
  2448. % @defvr Counter foo-count
  2449. \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
  2450. \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
  2451. \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
  2452. % @defvar == @defvr Variable
  2453. \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
  2454. \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
  2455. \begingroup\defname {#1}{Variable}%
  2456. \defvarargs {#2}\endgroup %
  2457. % @defopt == @defvr {User Option}
  2458. \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
  2459. \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
  2460. \begingroup\defname {#1}{User Option}%
  2461. \defvarargs {#2}\endgroup %
  2462. % @deftypevar int foobar
  2463. \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
  2464. % #1 is the data type.  #2 is the name.
  2465. \def\deftypevarheader #1#2{%
  2466. \doind {vr}{\code{#2}}% Make entry in variables index
  2467. \begingroup\defname {\code{#1} #2}{Variable}%
  2468. \interlinepenalty=10000
  2469. \endgraf\penalty 10000\vskip -\parskip\penalty 10000
  2470. \endgroup}
  2471. % @deftypevr {Global Flag} int enable
  2472. \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
  2473. \def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
  2474. \begingroup\defname {\code{#2} #3}{#1}
  2475. \interlinepenalty=10000
  2476. \endgraf\penalty 10000\vskip -\parskip\penalty 10000
  2477. \endgroup}
  2478. % This definition is run if you use @defvarx
  2479. % anywhere other than immediately after a @defvar or @defvarx.
  2480. \def\defvrx #1 {\errmessage{@defvrx in invalid context}}
  2481. \def\defvarx #1 {\errmessage{@defvarx in invalid context}}
  2482. \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
  2483. \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
  2484. \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
  2485. % Now define @deftp
  2486. % Args are printed in bold, a slight difference from @defvar.
  2487. \def\deftpargs #1{\bf \defvarargs{#1}}
  2488. % @deftp Class window height width ...
  2489. \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
  2490. \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
  2491. \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
  2492. % This definition is run if you use @deftpx, etc
  2493. % anywhere other than immediately after a @deftp, etc.
  2494. \def\deftpx #1 {\errmessage{@deftpx in invalid context}}
  2495. \message{cross reference,}
  2496. % Define cross-reference macros
  2497. \newwrite \auxfile
  2498. \newif\ifhavexrefs  % True if xref values are known.
  2499. \newif\ifwarnedxrefs  % True if we warned once that they aren't known.
  2500. % \setref{foo} defines a cross-reference point named foo.
  2501. \def\setref#1{%
  2502. %\dosetq{#1-title}{Ytitle}%
  2503. \dosetq{#1-pg}{Ypagenumber}%
  2504. \dosetq{#1-snt}{Ysectionnumberandtype}}
  2505. \def\unnumbsetref#1{%
  2506. %\dosetq{#1-title}{Ytitle}%
  2507. \dosetq{#1-pg}{Ypagenumber}%
  2508. \dosetq{#1-snt}{Ynothing}}
  2509. \def\appendixsetref#1{%
  2510. %\dosetq{#1-title}{Ytitle}%
  2511. \dosetq{#1-pg}{Ypagenumber}%
  2512. \dosetq{#1-snt}{Yappendixletterandtype}}
  2513. % \xref, \pxref, and \ref generate cross-references to specified points.
  2514. % For \xrefX, #1 is the node name, #2 the name of the Info
  2515. % cross-reference, #3 the printed node name, #4 the name of the Info
  2516. % file, #5 the name of the printed manual.  All but the node name can be
  2517. % omitted.
  2518. \def\pxref#1{see \xrefX[#1,,,,,,,]}
  2519. \def\xref#1{See \xrefX[#1,,,,,,,]}
  2520. \def\ref#1{\xrefX[#1,,,,,,,]}
  2521. \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup%
  2522. \def\printedmanual{\ignorespaces #5}%
  2523. \def\printednodename{\ignorespaces #3}%
  2524. \setbox1=\hbox{\printedmanual}%
  2525. \setbox0=\hbox{\printednodename}%
  2526. \ifdim \wd0=0pt%
  2527. \def\printednodename{\ignorespaces #1}%
  2528. %%% Uncommment the following line to make the actual chapter or section title
  2529. %%% appear inside the square brackets.
  2530. %\def\printednodename{#1-title}%
  2531. % If we use \unhbox0 and \unhbox1 to print the node names, TeX does
  2532. % not insert empty discretionaries after hyphens, which means that it
  2533. % will not find a line break at a hyphen in a node names.  Since some
  2534. % manuals are best written with fairly long node names, containing
  2535. % hyphens, this is a loss.  Therefore, we simply give the text of
  2536. % the node name again, so it is as if TeX is seeing it for the first
  2537. % time.
  2538. \ifdim \wd1>0pt
  2539. section ``\printednodename'' in \cite{\printedmanual}%
  2540. \else%
  2541. \turnoffactive%
  2542. \refx{#1-snt}{} [\printednodename], page\tie\refx{#1-pg}{}%
  2543. \endgroup}
  2544. % \dosetq is the interface for calls from other macros
  2545. % Use \turnoffactive so that punctuation chars such as underscore
  2546. % work in node names.
  2547. \def\dosetq #1#2{{\let\folio=0 \turnoffactive%
  2548. \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
  2549. \next}}
  2550. % \internalsetq {foo}{page} expands into
  2551. % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
  2552. % When the aux file is read, ' is the escape character
  2553. \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
  2554. % Things to be expanded by \internalsetq
  2555. \def\Ypagenumber{\folio}
  2556. \def\Ytitle{\thischapter}
  2557. \def\Ynothing{}
  2558. \def\Ysectionnumberandtype{%
  2559. \ifnum\secno=0 Chapter\xreftie\the\chapno %
  2560. \else \ifnum \subsecno=0 Section\xreftie\the\chapno.\the\secno %
  2561. \else \ifnum \subsubsecno=0 %
  2562. Section\xreftie\the\chapno.\the\secno.\the\subsecno %
  2563. \else %
  2564. Section\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
  2565. \fi \fi \fi }
  2566. \def\Yappendixletterandtype{%
  2567. \ifnum\secno=0 Appendix\xreftie'char\the\appendixno{}%
  2568. \else \ifnum \subsecno=0 Section\xreftie'char\the\appendixno.\the\secno %
  2569. \else \ifnum \subsubsecno=0 %
  2570. Section\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
  2571. \else %
  2572. Section\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
  2573. \fi \fi \fi }
  2574. \gdef\xreftie{'tie}
  2575. % Use TeX 3.0's \inputlineno to get the line number, for better error
  2576. % messages, but if we're using an old version of TeX, don't do anything.
  2577. \ifx\inputlineno\thisisundefined
  2578.   \let\linenumber = \empty % Non-3.0.
  2579. \else
  2580.   \def\linenumber{\the\inputlineno:\space}
  2581. % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
  2582. % If its value is nonempty, SUFFIX is output afterward.
  2583. \def\refx#1#2{%
  2584.   \expandafter\ifx\csname X#1\endcsname\relax
  2585.     % If not defined, say something at least.
  2586.     $\langle$un\-de\-fined$\rangle$%
  2587.     \ifhavexrefs
  2588.       \message{\linenumber Undefined cross reference `#1'.}%
  2589.     \else
  2590.       \ifwarnedxrefs\else
  2591.         \global\warnedxrefstrue
  2592.         \message{Cross reference values unknown; you must run TeX again.}%
  2593.       \fi
  2594.     \fi
  2595.   \else
  2596.     % It's defined, so just use it.
  2597.     \csname X#1\endcsname
  2598.   \fi
  2599.   #2% Output the suffix in any case.
  2600. % Read the last existing aux file, if any.  No error if none exists.
  2601. % This is the macro invoked by entries in the aux file.
  2602. \def\xrdef #1#2{
  2603. {\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
  2604. \def\readauxfile{%
  2605. \begingroup
  2606. \catcode `\^^@=\other
  2607. \catcode `\
  2608. =\other
  2609. \catcode `\
  2610. =\other
  2611. \catcode `\^^C=\other
  2612. \catcode `\^^D=\other
  2613. \catcode `\^^E=\other
  2614. \catcode `\^^F=\other
  2615. \catcode `\^^G=\other
  2616. \catcode `\^^H=\other
  2617. \catcode `\
  2618. =\other
  2619. \catcode `\^^L=\other
  2620. \catcode `\
  2621. =\other
  2622. \catcode `\
  2623. =\other
  2624. \catcode `\
  2625. =\other
  2626. \catcode `\
  2627. =\other
  2628. \catcode `\
  2629. =\other
  2630. \catcode `\
  2631. =\other
  2632. \catcode `\
  2633. =\other
  2634. \catcode `\
  2635. =\other
  2636. \catcode `\
  2637. =\other
  2638. \catcode `\
  2639. =\other
  2640. \catcode `\
  2641. =\other
  2642. \catcode `\
  2643. =\other
  2644. \catcode 26=\other
  2645. \catcode `\^^[=\other
  2646. \catcode `\^^\=\other
  2647. \catcode `\^^]=\other
  2648. \catcode `\^^^=\other
  2649. \catcode `\^^_=\other
  2650. \catcode `\@=\other
  2651. \catcode `\^=\other
  2652. \catcode `\~=\other
  2653. \catcode `\[=\other
  2654. \catcode `\]=\other
  2655. \catcode`\"=\other
  2656. \catcode`\_=\other
  2657. \catcode`\|=\other
  2658. \catcode`\<=\other
  2659. \catcode`\>=\other
  2660. \catcode `\$=\other
  2661. \catcode `\#=\other
  2662. \catcode `\&=\other
  2663. % `\+ does not work, so use 43.
  2664. \catcode 43=\other
  2665. % the aux file uses ' as the escape.
  2666. % Turn off \ as an escape so we do not lose on
  2667. % entries which were dumped with control sequences in their names.
  2668. % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
  2669. % Reference to such entries still does not work the way one would wish,
  2670. % but at least they do not bomb out when the aux file is read in.
  2671. \catcode `\{=1 \catcode `\}=2
  2672. \catcode `\%=\other
  2673. \catcode `\'=0
  2674. \catcode `\\=\other
  2675. \openin 1 \jobname.aux
  2676. \ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
  2677. % Open the new aux file.  Tex will close it automatically at exit.
  2678. \openout \auxfile=\jobname.aux
  2679. \endgroup}
  2680. % Footnotes.
  2681. \newcount \footnoteno
  2682. % The trailing space in the following definition for supereject is
  2683. % vital for proper filling; pages come out unaligned when you do a
  2684. % pagealignmacro call if that space before the closing brace is
  2685. % removed.
  2686. \def\supereject{\par\penalty -20000\footnoteno =0 }
  2687. % @footnotestyle is meaningful for info output only..
  2688. \let\footnotestyle=\comment
  2689. \let\ptexfootnote=\footnote
  2690. {\catcode `\@=11
  2691. \long\gdef\footnote #1{\global\advance \footnoteno by \@ne
  2692. \unskip
  2693. \edef\thisfootno{$^{\the\footnoteno}$}%
  2694. \let\@sf\empty
  2695. \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
  2696. \thisfootno\@sf \footnotezzz{#1}}
  2697. % \parsearg\footnotezzz}
  2698. \long\gdef\footnotezzz #1{\insert\footins{
  2699. \interlinepenalty\interfootnotelinepenalty
  2700. \splittopskip\ht\strutbox % top baseline for broken footnotes
  2701. \splitmaxdepth\dp\strutbox \floatingpenalty\@MM
  2702. \leftskip\z@skip \rightskip\z@skip \spaceskip\z@skip \xspaceskip\z@skip
  2703. \footstrut\parindent=\defaultparindent\hang\textindent{\thisfootno}#1\strut}}
  2704. }%end \catcode `\@=11
  2705. % Set the baselineskip to #1, and the lineskip and strut size
  2706. % correspondingly.  There is no deep meaning behind these magic numbers
  2707. % used as factors; they just match (closely enough) what Knuth defined.
  2708. \def\lineskipfactor{.1}
  2709. \def\strutheightpercent{.71}
  2710. \def\strutdepthpercent{.29}
  2711. \def\setleading#1{%
  2712.   \baselineskip = #1\relax
  2713.   \normalbaselineskip = \baselineskip
  2714.   \lineskip = \lineskipfactor\baselineskip
  2715.   \setbox\strutbox =\hbox{%
  2716.     \vrule width0pt height\strutheightpercent\baselineskip
  2717.                     depth \strutdepthpercent \baselineskip
  2718. % @| inserts a changebar to the left of the current line.  It should
  2719. % surround any changed text.  This approach does *not* work if the
  2720. % change spans more than two lines of output.  To handle that, we would
  2721. % have adopt a much more difficult approach (putting marks into the main
  2722. % vertical list for the beginning and end of each change).
  2723. \def\|{%
  2724.   % \vadjust can only be used in horizontal mode.
  2725.   \leavevmode
  2726.   % Append this vertical mode material after the current line in the output.
  2727.   \vadjust{%
  2728.     % We want to insert a rule with the height and depth of the current
  2729.     % leading; that is exactly what \strutbox is supposed to record.
  2730.     \vskip-\baselineskip
  2731.     %
  2732.     % \vadjust-items are inserted at the left edge of the type.  So
  2733.     % the \llap here moves out into the left-hand margin.
  2734.     \llap{%
  2735.       %
  2736.       % For a thicker or thinner bar, change the `1pt'.
  2737.       \vrule height\baselineskip width1pt
  2738.       %
  2739.       % This is the space between the bar and the text.
  2740.       \hskip 12pt
  2741.     }%
  2742. % For a final copy, take out the rectangles
  2743. % that mark overfull boxes (in case you have decided
  2744. % that the text looks ok even though it passes the margin).
  2745. \def\finalout{\overfullrule=0pt}
  2746. % End of control word definitions.
  2747. \message{and turning on texinfo input format.}
  2748. \def\openindices{%
  2749.    \newindex{cp}%
  2750.    \newcodeindex{fn}%
  2751.    \newcodeindex{vr}%
  2752.    \newcodeindex{tp}%
  2753.    \newcodeindex{ky}%
  2754.    \newcodeindex{pg}%
  2755. % Set some numeric style parameters, for 8.5 x 11 format.
  2756. %\hsize = 6.5in
  2757. \newdimen\defaultparindent \defaultparindent = 15pt
  2758. \parindent = \defaultparindent
  2759. \parskip 18pt plus 1pt
  2760. \setleading{15pt}
  2761. \advance\topskip by 1.2cm
  2762. % Prevent underfull vbox error messages.
  2763. \vbadness=10000
  2764. % Following George Bush, just get rid of widows and orphans.
  2765. \widowpenalty=10000
  2766. \clubpenalty=10000
  2767. % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
  2768. % using an old version of TeX, don't do anything.  We want the amount of
  2769. % stretch added to depend on the line length, hence the dependence on
  2770. % \hsize.  This makes it come to about 9pt for the 8.5x11 format.
  2771. \ifx\emergencystretch\thisisundefined \else
  2772.   \emergencystretch = \hsize
  2773.   \divide\emergencystretch by 45
  2774. % Use @smallbook to reset parameters for 7x9.5 format  (or else 7x9.25)
  2775. \def\smallbook{
  2776. % These values for secheadingskip and subsecheadingskip are
  2777. % experiments.  RJC 7 Aug 1992
  2778. \global\secheadingskip = 17pt plus 6pt minus 3pt
  2779. \global\subsecheadingskip = 14pt plus 6pt minus 3pt
  2780. \global\lispnarrowing = 0.3in
  2781. \setleading{12pt}
  2782. \advance\topskip by -1cm
  2783. \global\parskip 3pt plus 1pt
  2784. \global\hsize = 5in
  2785. \global\vsize=7.5in
  2786. \global\tolerance=700
  2787. \global\hfuzz=1pt
  2788. \global\contentsrightmargin=0pt
  2789. \global\pagewidth=\hsize
  2790. \global\pageheight=\vsize
  2791. \global\let\smalllisp=\smalllispx
  2792. \global\let\smallexample=\smalllispx
  2793. \global\def\Esmallexample{\Esmalllisp}
  2794. % Use @afourpaper to print on European A4 paper.
  2795. \def\afourpaper{
  2796. \global\tolerance=700
  2797. \global\hfuzz=1pt
  2798. \setleading{12pt}
  2799. \global\parskip 15pt plus 1pt
  2800. \global\vsize= 53\baselineskip
  2801. \advance\vsize by \topskip
  2802. %\global\hsize=   5.85in     % A4 wide 10pt
  2803. \global\hsize=  6.5in
  2804. \global\outerhsize=\hsize
  2805. \global\advance\outerhsize by 0.5in
  2806. \global\outervsize=\vsize
  2807. \global\advance\outervsize by 0.6in
  2808. \global\pagewidth=\hsize
  2809. \global\pageheight=\vsize
  2810. % Define macros to output various characters with catcode for normal text.
  2811. \catcode`\"=\other
  2812. \catcode`\~=\other
  2813. \catcode`\^=\other
  2814. \catcode`\_=\other
  2815. \catcode`\|=\other
  2816. \catcode`\<=\other
  2817. \catcode`\>=\other
  2818. \catcode`\+=\other
  2819. \def\normaldoublequote{"}
  2820. \def\normaltilde{~}
  2821. \def\normalcaret{^}
  2822. \def\normalunderscore{_}
  2823. \def\normalverticalbar{|}
  2824. \def\normalless{<}
  2825. \def\normalgreater{>}
  2826. \def\normalplus{+}
  2827. % This macro is used to make a character print one way in ttfont
  2828. % where it can probably just be output, and another way in other fonts,
  2829. % where something hairier probably needs to be done.
  2830. % #1 is what to print if we are indeed using \tt; #2 is what to print
  2831. % otherwise.  Since all the Computer Modern typewriter fonts have zero
  2832. % interword stretch (and shrink), and it is reasonable to expect all
  2833. % typewriter fonts to have this, we can check that font parameter.
  2834. \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
  2835. % Turn off all special characters except @
  2836. % (and those which the user can use as if they were ordinary).
  2837. % Most of these we simply print from the \tt font, but for some, we can
  2838. % use math or other variants that look better in normal text.
  2839. \catcode`\"=\active
  2840. \def\activedoublequote{{\tt \char '042}}
  2841. \let"=\activedoublequote
  2842. \catcode`\~=\active
  2843. \def~{{\tt \char '176}}
  2844. \chardef\hat=`\^
  2845. \catcode`\^=\active
  2846. \def^{{\tt \hat}}
  2847. \catcode`\_=\active
  2848. \def_{\ifusingtt\normalunderscore\_}
  2849. % Subroutine for the previous macro.
  2850. \def\_{\lvvmode \kern.06em \vbox{\hrule width.3em height.1ex}}
  2851. % \lvvmode is equivalent in function to \leavevmode.
  2852. % Using \leavevmode runs into trouble when written out to
  2853. % an index file due to the expansion of \leavevmode into ``\unhbox
  2854. % \voidb@x'' ---which looks to TeX like ``\unhbox \voidb\x'' due to our
  2855. % magic tricks with @.
  2856. \def\lvvmode{\vbox to 0pt{}}
  2857. \catcode`\|=\active
  2858. \def|{{\tt \char '174}}
  2859. \chardef \less=`\<
  2860. \catcode`\<=\active
  2861. \def<{{\tt \less}}
  2862. \chardef \gtr=`\>
  2863. \catcode`\>=\active
  2864. \def>{{\tt \gtr}}
  2865. \catcode`\+=\active
  2866. \def+{{\tt \char 43}}
  2867. %\catcode 27=\active
  2868. %\def^^[{$\diamondsuit$}
  2869. % Used sometimes to turn off (effectively) the active characters
  2870. % even after parsing them.
  2871. \def\turnoffactive{\let"=\normaldoublequote
  2872. \let~=\normaltilde
  2873. \let^=\normalcaret
  2874. \let_=\normalunderscore
  2875. \let|=\normalverticalbar
  2876. \let<=\normalless
  2877. \let>=\normalgreater
  2878. \let+=\normalplus}
  2879. % Set up an active definition for =, but don't enable it most of the time.
  2880. {\catcode`\==\active
  2881. \global\def={{\tt \char 61}}}
  2882. \catcode`\@=0
  2883. % \rawbackslashxx output one backslash character in current font
  2884. \global\chardef\rawbackslashxx=`\\
  2885. %{\catcode`\\=\other
  2886. %@gdef@rawbackslashxx{\}}
  2887. % \rawbackslash redefines \ as input to do \rawbackslashxx.
  2888. {\catcode`\\=\active
  2889. @gdef@rawbackslash{@let\=@rawbackslashxx }}
  2890. % \normalbackslash outputs one backslash in fixed width font.
  2891. \def\normalbackslash{{\tt\rawbackslashxx}}
  2892. % Say @foo, not \foo, in error messages.
  2893. \escapechar=`\@
  2894. % \catcode 17=0   % Define control-q
  2895. \catcode`\\=\active
  2896. % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
  2897. % That is what \eatinput is for; after that, the `\' should revert to printing 
  2898. % a backslash.
  2899. @gdef@eatinput input texinfo{@fixbackslash}
  2900. @global@let\ = @eatinput
  2901. % On the other hand, perhaps the file did not have a `\input texinfo'. Then
  2902. % the first `\{ in the file would cause an error. This macro tries to fix 
  2903. % that, assuming it is called before the first `\' could plausibly occur.
  2904. @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi}
  2905. %% These look ok in all fonts, so just make them not special.  The @rm below
  2906. %% makes sure that the current font starts out as the newly loaded cmr10
  2907. @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
  2908. @textfonts
  2909. @c Local variables:
  2910. @c page-delimiter: "^\\\\message"
  2911. @c End:
  2912.